gcubed.projections.simulation_layer_definition

This module contains the SimulationLayerDefinition class.

It contains the metadata describing a specific simulation layer in an experiment.

class SimulationLayerDefinition(gcubed.base.Base):

Sets up and checks metadata about a simulation layer

SimulationLayerDefinition( sym_data: gcubed.sym_data.SymData, name: str, event_year: int, data_filename: pathlib.Path, description: str | None)

baseline_projections: The baseline projections that this simulation layer will be applied to.

name: the name of the simulation layer

event_year: YYYY format integer that is the year that the simulation layer details became known to the agents in the model.

filename: The full filename of the file containing the simulation layer data.

description: The optional text explanation of the simulation layer. When omitted, the public description falls back to the layer name.

name: str

description: str

explicit_description: str | None

Return the authored description without the display fallback.

event_year: int

data_filename: pathlib.Path

sym_data: gcubed.sym_data.SymData