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

  • _disable_slurm » backend

  • _lower_backend » backend

  • _lower_protocol » protocol

  • _validate_rbfe_section » all fields

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

Execution backend.

Validated by:

  • _coerce_fe_sim_model

  • _disable_slurm

  • _lower_backend

  • _validate_rbfe_section

field create: CreateArgs [Required]#

Settings for system creation/staging.

Validated by:

  • _coerce_fe_sim_model

  • _validate_rbfe_section

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

Simulation parameter overrides.

Validated by:

  • _coerce_fe_sim_model

  • _validate_rbfe_section

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

High-level protocol to execute.

Validated by:

  • _coerce_fe_sim_model

  • _lower_protocol

  • _validate_rbfe_section

field rbfe: RBFENetworkArgs | None = None#

RBFE network mapping configuration.

Validated by:

  • _coerce_fe_sim_model

  • _validate_rbfe_section

field run: RunSection [Required]#

Execution controls and artifact destination.

Validated by:

  • _coerce_fe_sim_model

  • _validate_rbfe_section

field version: int = 1#

Schema version of the run configuration.

Validated by:

  • _coerce_fe_sim_model

  • _validate_rbfe_section