pyrevs.sampler.system_config

A configuration class to expose limited configuration.

Classes

SystemConfig

Overarching system configuration.

Module Contents

class SystemConfig[source]

Overarching system configuration.

This is a helper metadata class for the system configuration used to IO full configuration (i.e. including defaults) and performing configuration merging.

sampler: pyrevs.sampler.config.SamplerConfig[source]
runtime: pyrevs.core.RuntimeConfig[source]
strategy: pyrevs.strategies.ams.AMSConfig | pyrevs.strategies.montecarlo.MCConfig[source]
database: pyrevs.database.DatabaseConfig[source]
runner: pyrevs.runner.RunnerConfig[source]
trajectory: pyrevs.trajectory.TrajectoryConfig[source]
write_toml(path: pathlib.Path, other_data: dict[str, Any]) None[source]

Write the system configuration to a TOML file.

classmethod merge(old: SystemConfig, new: SystemConfig) SystemConfig[source]

Merge two SystemConfig objects.

Immutable sections must match exactly. Replaceable sections are overwritten by new.

Parameters:
  • old – Existing configuration (e.g. from database).

  • new – Incoming configuration (e.g. from CLI/TOML).

Returns:

A merged SystemConfig instance.

Raises:

ValueError – If immutable sections differ.

classmethod print_config_help() None[source]

Print a help message for the system configuration.