oasislmf.cli.model
==================

.. py:module:: oasislmf.cli.model


Classes
-------

.. autoapisummary::

   oasislmf.cli.model.GenerateExposurePreAnalysisCmd
   oasislmf.cli.model.GeneratePostFileGenCmd
   oasislmf.cli.model.GeneratePrelossCmd
   oasislmf.cli.model.GenerateKeysCmd
   oasislmf.cli.model.GenerateOasisFilesCmd
   oasislmf.cli.model.GenerateLossesCmd
   oasislmf.cli.model.GenerateLossesPartialCmd
   oasislmf.cli.model.GenerateLossesOutputCmd
   oasislmf.cli.model.RunCmd
   oasislmf.cli.model.ModelCmd


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

.. py:class:: GenerateExposurePreAnalysisCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generate a new EOD from original one by specifying a model specific pre-analysis hook for exposure modification
   see ExposurePreAnalysis for more detail


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'ExposurePreAnalysis'



.. py:class:: GeneratePostFileGenCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generate a new EOD from original one by specifying a model specific pre-analysis hook for exposure modification
   see ExposurePreAnalysis for more detail


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PostFileGen'



.. py:class:: GeneratePrelossCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generate a new EOD from original one by specifying a model specific pre-analysis hook for exposure modification
   see ExposurePreAnalysis for more detail


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PreLoss'



.. py:class:: GenerateKeysCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generates keys from a model lookup, and write Oasis keys and keys error files.


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateKeys'



.. py:class:: GenerateOasisFilesCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generates the standard Oasis GUL input files + optionally the IL/FM input
   files and the RI input files.


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateOasisFiles'



.. py:class:: GenerateLossesCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Generates the standard Oasis GUL input files + optionally the IL/FM input
   files and the RI input files.


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateOasisLosses'



.. py:class:: GenerateLossesPartialCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Distributed Oasis CMD: desc todo


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateLossesPartial'



.. py:class:: GenerateLossesOutputCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Distributed Oasis CMD: desc todo


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateLossesOutput'



.. py:class:: RunCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Run models end to end.

   The command line arguments can be supplied in the configuration file
   (``oasislmf.json`` by default or specified with the ``--config`` flag).


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'RunModel'



.. py:class:: ModelCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisBaseCommand`


   Model subcommands::

       * generating keys files from model lookups
       * generating Oasis input CSV files (GUL [+ IL, RI])
       * generating losses from a preexisting set of Oasis input CSV files
       * generating deterministic losses (no model)
       * running a model end-to-end


   .. py:attribute:: sub_commands