oasislmf.computation.run.platform
=================================

.. py:module:: oasislmf.computation.run.platform


Classes
-------

.. autoapisummary::

   oasislmf.computation.run.platform.PlatformBase
   oasislmf.computation.run.platform.PlatformList
   oasislmf.computation.run.platform.PlatformRun
   oasislmf.computation.run.platform.PlatformDelete
   oasislmf.computation.run.platform.PlatformGet


Module Contents
---------------

.. py:class:: PlatformBase(**kwargs)

   Bases: :py:obj:`oasislmf.computation.base.ComputationStep`


   Base platform class to handle opening a client connection


   .. py:attribute:: step_params


   .. py:attribute:: server


   .. py:method:: load_credentials(login_arg)

      Load credentials from JSON file or Prompt for username / password

      Options:
          1.'--server-login ./APIcredentials.json'
          2. Load credentials from default config file '-C oasislmf.json'



   .. py:method:: open_connection()


   .. py:method:: tabulate_json(json_data, items)


   .. py:method:: print_endpoint(attr, items)


   .. py:method:: select_id(msg, valid_ids)


.. py:class:: PlatformList(**kwargs)

   Bases: :py:obj:`PlatformBase`


   Return status and details from an Oasis Platform API server
       


   .. py:attribute:: step_params


   .. py:method:: run()


.. py:class:: PlatformRun(**kwargs)

   Bases: :py:obj:`PlatformBase`


   End to End - run model via the Oasis Platoform API
       


   .. py:attribute:: chained_commands


   .. py:method:: run()


.. py:class:: PlatformDelete(**kwargs)

   Bases: :py:obj:`PlatformBase`


   Delete either a 'model', 'portfolio' or an 'analysis' from the API's Database
       


   .. py:attribute:: step_params


   .. py:method:: delete_list(attr, id_list)


   .. py:method:: run()


.. py:class:: PlatformGet(**kwargs)

   Bases: :py:obj:`PlatformBase`


   Download file(s) from the api
       


   .. py:attribute:: step_params


   .. py:method:: extract_args(param_suffix)


   .. py:method:: download(collection, req_files, chuck_size=1024)


   .. py:method:: run()