bout_runners.configure_bout_runners

Module for configuring bout_runners.

Functions

check_submitter_config(…)	Check that the submitter configuration file is properly formatted.
set_bout_directory([bout_dir])	Set the path to the BOUT++ directory.
set_log_file_directory([log_dir])	Set the directory of the log files.
set_log_level([level])	Set the log level.
set_submitter_config_path([…])	Set the path to the submitter configuration.

bout_runners.configure_bout_runners.check_submitter_config(submitter_config_path: pathlib.Path, default_path: pathlib.Path) → None

Check that the submitter configuration file is properly formatted.

Parameters

submitter_config_pathPath

Path to the specified submitter configuration path

default_pathPath

Path to the default submitter configuration

Raises

ValueError

If either sections or options are missing from the submitter_config_path

bout_runners.configure_bout_runners.set_bout_directory(bout_dir: Optional[pathlib.Path] = None) → None

Set the path to the BOUT++ directory.

Parameters

bout_dirNone or Path

The path to the BOUT++ directory If None, the caller will be prompted

Raises

ValueError

If BOUT++ not found in the directory

bout_runners.configure_bout_runners.set_log_file_directory(log_dir: Optional[pathlib.Path] = None) → None

Set the directory of the log files.

Parameters

log_dirNone or Path

The directory to keep the log files If None the caller will be prompted

bout_runners.configure_bout_runners.set_log_level(level: Optional[str] = None) → None

Set the log level.

Parameters

levelNone or str

The logging level to use If None the caller will be prompted

Raises

ValueError

If the level is not one of the possibilities

bout_runners.configure_bout_runners.set_submitter_config_path(submitter_config_path: Optional[pathlib.Path] = None) → None

Set the path to the submitter configuration.

Parameters

submitter_config_pathNone or Path

The path to the submitter config file If None, the caller will be prompted