oasislmf.cli.config

Module Contents

Classes

ConfigUpdateCmd	Read in an MDK config file and writes an updated file, replacing deprecated keys
ConfigCmd	Describes the format of the configuration (JSON) file to use the MDK

class oasislmf.cli.config.ConfigUpdateCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisBaseCommand

Read in an MDK config file and writes an updated file, replacing deprecated keys with newer ones compatible with the current MDK release

add_args(parser)

Adds arguments to the argument parser.

Parameters:

parser (ArgumentParser) – The argument parser object

action(args)

Parameters:

args (Namespace) – The arguments from the command line

class oasislmf.cli.config.ConfigCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisBaseCommand

Describes the format of the configuration (JSON) file to use the MDK model run command for running models end-to-end.

One file will need to be defined per model, usually in the model repository and with an indicative name.

The path-related keys should be strings, given relative to the location of configuration file. Optional arguments for a command are usually defaulted with appropriate values, but can be overridden by providing a runtime flag.

Analysis_settings_json:

Analysis settings (JSON) file path

Lookup_data_dir:

Model lookup/keys data path (optional)

Lookup_config_json:

Model built-in lookup config. (JSON) file path (optional)

Lookup_package_dir:

Model custom lookup package path (optional)

Model_version_csv:

Model version (CSV) file path (optional)

Model_data_dir:

Model data path

Model_package_dir:

Path to the directory to use as the model specific package (optional)

Model_run_dir:

Model run directory (optional)

Oed_location_csv:

Source OED exposure (CSV) file path

Oed_accounts_csv:

Source OED accounts (CSV) file path (optional)

Oed_info_csv:

Reinsurance (RI) info. file path (optional)

Oed_scope_csv:

RI scope file path (optional)

Profile_location_csv:

Source OED exposure (JSON) profile describing the financial terms contained in the source exposure file (optional)

Profile_accounts_json:

Source OED accouns (JSON) profile describing the financial terms contained in the source accounts file (optional)

Summarise_exposure:

Generates an exposure summary report in JSON

Ktools_num_processes:

The number of concurrent processes used by ktools during model execution - default is 2

Ktools_fifo_relative:

Whether to create ktools FIFO queues under the ./fifo subfolder (in the model run directory)

Ktools_alloc_rule_gul:

Override the allocation used in fmcalc - default is 1

Ktools_alloc_rule_il:

Override the allocation used in fmcalc - default is 2

formatter_class

sub_commands