oasislmf.cli.root

Classes

RootCmd

Tool for managing oasislmf models.

Functions

main()

CLI entrypoint for running the whole RootCmd

Module Contents

class oasislmf.cli.root.RootCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisBaseCommand

Tool for managing oasislmf models.

sub_commands

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.

Parameters:

args (Namespace) – 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.

Returns:

The status code of the action (0 on success)

oasislmf.cli.root.main()

CLI entrypoint for running the whole RootCmd