Skip to content

Run

run

Configuration for the run control.

Classes

RunConfiguration

Bases: BaseModel

Configuration for the run control.

Attributes
name class-attribute instance-attribute 
name: str = Field(default='simulation', description='Run identifier.')

Run identifier.

seed class-attribute instance-attribute 
seed: int = Field(default=42, description='Global RNG seed (overridable via CLI).')

Global RNG seed (overridable via CLI).

mode class-attribute instance-attribute 
mode: Literal['fixed_n_samples', 'duration'] = Field(default='fixed_n_samples', description="Mode of simulation. Supported: 'fixed_n_samples', 'duration'.")

Mode of simulation. Supported: 'fixed_n_samples', 'duration'.

n_samples class-attribute instance-attribute 
n_samples: int = Field(default=1000000, gt=0, description="Number of samples. Only used when 'mode' is 'fixed_n_samples'.")

Number of samples. Only used when 'mode' is 'fixed_n_samples'.

duration class-attribute instance-attribute 
duration: float = Field(default=1.0, gt=0.0, description="Duration in year (365 days). This is used when 'mode' is 'duration'.")

Duration in year (365 days). This is used when 'mode' is 'duration'.

output class-attribute instance-attribute 
output: OutputConfiguration = Field(default_factory=OutputConfiguration, description='Configuration for the output.')

Configuration for the output.

logging class-attribute instance-attribute 
logging: LoggingConfiguration = Field(default_factory=LoggingConfiguration, description='Configuration for the logging.')

Configuration for the logging.