batter.config.run.RunConfig#

pydantic model batter.config.run.RunConfig[source]#

Top-level YAML config.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Config:

  • extra: str = forbid

Fields:
Validators:

  • _coerce_fe_sim_model » all fields

  • _lower_backend » backend

  • _lower_protocol » protocol

field backend: Literal['local', 'slurm'] = 'local'#

Execution backend.

Validated by:

  • _coerce_fe_sim_model

  • _lower_backend

field create: CreateArgs [Required]#

Settings for system creation/staging.

Validated by:

  • _coerce_fe_sim_model

field fe_sim: Dict[str, Any] | FESimArgs | MDSimArgs [Optional]#

Simulation parameter overrides.

Validated by:

  • _coerce_fe_sim_model

field protocol: Literal['abfe', 'asfe', 'md'] = 'abfe'#

High-level protocol to execute.

Validated by:

  • _coerce_fe_sim_model

  • _lower_protocol

field run: RunSection [Required]#

Execution controls and artifact destination.

Validated by:

  • _coerce_fe_sim_model

field version: int = 1#

Schema version of the run configuration.

Validated by:

  • _coerce_fe_sim_model

classmethod load(path: Path | str) → RunConfig[source]#

Load and validate a run configuration from disk.

Parameters:

path (str or pathlib.Path) – Location of the YAML file to parse.

Returns:

Fully validated configuration object.

Return type:

RunConfig

classmethod model_validate_yaml(yaml_text: str) → RunConfig[source]#

Validate a run configuration from an in-memory YAML string.

Parameters:

yaml_text (str) – Raw YAML content describing the run configuration.

Returns:

Validated configuration model.

Return type:

RunConfig

resolved_sim_config() → SimulationConfig[source]#

Build the effective simulation configuration for this run.

Returns:

Simulation parameters derived from create and fe_sim sections.

Return type:

SimulationConfig

with_base_dir(base_dir: Path) → RunConfig[source]#

Return a copy with relative paths resolved against base_dir.