bout_runners.utils.paths¶

Contains methods which return common paths.

Functions

`get_bout_directory`()	Load the BOUT++ directory from the configuration file.
`get_bout_runners_config_path`()	Return the absolute path to the bout_runners configuration.
`get_bout_runners_configuration`()	Return the bout_runners configuration.
`get_bout_runners_package_path`()	Return the absolute path to the bout_runners package.
`get_config_path`()	Return the absolute path to the configurations.
`get_default_submitters_config_path`()	Return the absolute path to the default submitters configuration.
`get_log_file_directory`()	Return the log_file directory.
`get_log_file_path`([log_file_dir, name])	Return the absolute path to the log file path.
`get_logger_config_path`()	Return the absolute path to the logger configuration.
`get_submitters_config_path`()	Return the path to the submitter configuration.
`get_submitters_configuration`()	Return the submitters configuration.

bout_runners.utils.paths.get_bout_directory() → pathlib.Path[source]¶

Load the BOUT++ directory from the configuration file.

Returns

bout_pathPath: Path to the BOUT++ repository

bout_runners.utils.paths.get_bout_runners_config_path() → pathlib.Path[source]¶

Return the absolute path to the bout_runners configuration.

Returns

Path: The path to the bout_runners configuration file

bout_runners.utils.paths.get_bout_runners_configuration() → configparser.ConfigParser[source]¶

Return the bout_runners configuration.

Returns

configconfigparser.ConfigParser: The configuration of bout_runners

bout_runners.utils.paths.get_bout_runners_package_path() → pathlib.Path[source]¶

Return the absolute path to the bout_runners package.

Returns

Path: The path to the root directory

bout_runners.utils.paths.get_config_path() → pathlib.Path[source]¶

Return the absolute path to the configurations.

Returns

Path: The path to the configuration directory

bout_runners.utils.paths.get_default_submitters_config_path() → pathlib.Path[source]¶

Return the absolute path to the default submitters configuration.

Returns

Path: The default path to the submitters configuration file

bout_runners.utils.paths.get_log_file_directory() → pathlib.Path[source]¶

Return the log_file directory.

Returns

log_file_directoryPath: Path to the log_file directory

bout_runners.utils.paths.get_log_file_path(log_file_dir: Optional[pathlib.Path] = None, name: Optional[str] = None) → pathlib.Path[source]¶

Return the absolute path to the log file path.

Parameters

log_file_dirPath or None: Path to the log file directory If None, default log file directory will be used
namestr or None: Name of the log file If None, current date will be used

Returns

log_file_pathPath: The path to the log file

bout_runners.utils.paths.get_logger_config_path() → pathlib.Path[source]¶

Return the absolute path to the logger configuration.

Returns

Path: The path to the logger configuration file

bout_runners.utils.paths.get_submitters_config_path() → pathlib.Path[source]¶

Return the path to the submitter configuration.

Returns

submitters_config_pathPath: Path to the submitters configuration

bout_runners.utils.paths.get_submitters_configuration() → configparser.ConfigParser[source]¶

Return the submitters configuration.

Returns

configconfigparser.ConfigParser: The submitter configuration