Configuration

configuration

Representations of parsed configuration files.

ConfigurationModel

Bases: YamlSerializableBaseModel

Configuration model for flepimop2.

This model serves as the parent container for a parsed configuration file.

Attributes:

Name	Type	Description
name	str | None	An optional name for the configuration.
engines	dict[str, ModuleModel]	A dictionary of engine configurations.
systems	dict[str, ModuleModel]	A dictionary of system configurations.
backends	dict[str, ModuleModel]	A dictionary of backend configurations.
process	dict[str, ModuleModel]	A dictionary of process configurations.
parameters	dict[str, ParameterSpecificationModel]	A dictionary of parameter configurations.
simulate	dict[str, SimulateSpecificationModel]	A dictionary of simulation configurations.

FixedParameterSpecificationModel

Bases: BaseModel

Fixed parameter specification model.

This model represents a parameter with a fixed value.

Attributes:

Name	Type	Description
type	Literal['fixed']	The type of the parameter specification, fixed to "fixed".
value	float	The fixed numeric value of the parameter.

Examples:

>>> from flepimop2.configuration import FixedParameterSpecificationModel
>>> param = FixedParameterSpecificationModel(value=12.34)
>>> param
FixedParameterSpecificationModel(type='fixed', value=12.34)
>>> param.model_dump()
12.34

ModuleModel

Bases: BaseModel

Module configuration model for flepimop2.

Attributes:

Name	Type	Description
module	str	The type of the module.

SimulateSpecificationModel

Bases: BaseModel

Model for specifying a simulation for flepimop2.

Attributes:

Name	Type	Description
engine	str	The name of the engine to use for the simulation.
system	str	The name of the system to simulate.
backend	str	The name of the backend to use for the simulation.
times	list[float]	A list of time points at which to perform the simulation.
params	dict[str, float] | None	Optional dictionary of parameters for the simulation.