Skip to content

cli

Utilities for commandline usage of experiments.

This module provides common utilities for commandline usage of experiments. It is intended to be used as a library for writing commandline interfaces for experiments.

initialize(**kwargs)

Initialize the experiment environment.

Loads the configuration and sets up logging according to its settings.

Parameters:

Name Type Description Default
**kwargs Any

Additional configuration overrides.

 {}

Returns:

Type Description
DictConfig | ListConfig

The initialized configuration object.
Source code in src/flowcean/cli/config.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def initialize(**kwargs: Any) -> DictConfig | ListConfig:
    """Initialize the experiment environment.

    Loads the configuration and sets up logging according to its settings.

    Args:
        **kwargs: Additional configuration overrides.

    Returns:
        The initialized configuration object.
    """
    conf = load_experiment_config(**kwargs)
    logging.basicConfig(**conf.logging.root)
    for logger_name, logger_conf in conf.logging.items():
        if logger_name == "root":
            continue
        logger = logging.getLogger(logger_name)
        logger.setLevel(logger_conf.level)
    return conf