Energy model

The energy model is used to create a simulation based on a dataset. The model parameters allows to override the default values provided by the dataset.

pydantic model ensysmod.schemas.EnergyModelCreate

Attributes to receive via API on creation of an energy model.

field ref_dataset: int [Required]

ID of the dataset that the energy model is based on.

Constraints:

• gt = 0

field override_parameters: list[EnergyModelOverrideCreate] = []

Override parameters of the energy model. If given, overrides the values of the referenced dataset.

field optimization_parameters: EnergyModelOptimizationCreate | None = None

Optimization parameters of the energy model.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

field name: str [Required]

Name of the energy model.

Constraints:

• min_length = 1

• max_length = 255

field description: str | None = None

Description of the energy model

Constraints:

• max_length = 1024