oasislmf.cli.test
=================

.. py:module:: oasislmf.cli.test


Classes
-------

.. autoapisummary::

   oasislmf.cli.test.ModelValidationCmd
   oasislmf.cli.test.FmValidationCmd
   oasislmf.cli.test.GenerateDummyModelFilesCmd
   oasislmf.cli.test.GenerateDummyOasisFilesCmd
   oasislmf.cli.test.GenerateLossesDummyModelCmd
   oasislmf.cli.test.TestModelCmd
   oasislmf.cli.test.TestCmd


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

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

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


   Checks the validity of a set of model data.


   .. py:method:: add_args(parser)

      Adds arguments to the argument parser.

      :param parser: The argument parser object
      :type parser: ArgumentParser



   .. py:method:: action(args)

      Performs validity checks on model data csv files using ktools
      executables.

      :param args: The arguments from the command line
      :type args: Namespace



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

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


   Run FM acceptance tests from "oasisLMF/validation/*"

   Example use:
   1. Run all test cases: "oasisLMF/validation$ oasislmf test fm"
       Stating oasislmf command - RunFmTest
       RUNNING: oasislmf.manager.interface
       Running: 4 Tests from '/home/sam/repos/core/oasisLMF/validation'
       Test names: ['insurance', 'insurance_step', 'reinsurance1', 'reinsurance2']
        ...

   2. Run Directly from a acceptance test Directory: "oasisLMF/validation/reinsurance1$ oasislmf test fm"
       Stating oasislmf command - RunFmTest
       RUNNING: oasislmf.manager.interface
        ...

   3. Select test case sub-directory: "oasisLMF/validation$ oasislmf test fm --test-case-name reinsurance1"
       Stating oasislmf command - RunFmTest
       RUNNING: oasislmf.manager.interface
        ...


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'RunFmTest'



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

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


   Eventually, the Parent class for all Oasis Computation Command
   create the command line interface from parameter define in the associated computation step


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateDummyModelFiles'



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

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


   Eventually, the Parent class for all Oasis Computation Command
   create the command line interface from parameter define in the associated computation step


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateDummyOasisFiles'



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

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


   Eventually, the Parent class for all Oasis Computation Command
   create the command line interface from parameter define in the associated computation step


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'GenerateLossesDummyModel'



.. py:class:: TestModelCmd(name=None, argv=None)

   Bases: :py:obj:`argparsetree.BaseCommand`


   Present sub-commands for creating test models


   .. py:attribute:: sub_commands


.. py:class:: TestCmd(name=None, argv=None)

   Bases: :py:obj:`argparsetree.BaseCommand`


   Test models and keys servers


   .. py:attribute:: sub_commands