oasislmf.cli.root
=================

.. py:module:: oasislmf.cli.root


Classes
-------

.. autoapisummary::

   oasislmf.cli.root.RootCmd


Functions
---------

.. autoapisummary::

   oasislmf.cli.root.main


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

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

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


   Tool for managing oasislmf models.


   .. py:attribute:: sub_commands


   .. py:method:: run(args=None)

      Runs the command passing in the parsed arguments. If an ``OasisException`` is
      raised the exception is caught, the error is logged and the process exits with
      an error code of 1.

      :param args: The arguments to run the command with. If ``None`` the arguments
          are gathered from the argument parser. This is automatically set when calling
          sub commands and in most cases should not be set for the root command.
      :type args: Namespace

      :return: The status code of the action (0 on success)



.. py:function:: main()

   CLI entrypoint for running the whole RootCmd