eta_ctrl.config.config_paths module

class eta_ctrl.config.config_paths.ConfigPaths(*, state_file_relpath: Path | None = None, results_relpath: Path = PosixPath('results'), scenarios_relpath: Path = PosixPath('scenarios'))[source]

Bases: BaseModel

model_config = {'extra': 'forbid', 'frozen': True, 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

state_file_relpath: Path | None

Relative path to the state_config file (default: [environment_classname]_state_config). The method from_file() will first try at the root path, then search in the /environment folder if not successful.

results_relpath: Path

Relative path to the results folder.

scenarios_relpath: Path

Relative path to the scenarios folder.