Energy model override parameters

The energy model parameter overrides the default values provided within the dataset.

In order to override a specific parameter, you must provide the following parameters:

  • component: The name of the energy component.

  • attribute: The name of the parameter. (like yearly_limit)

  • operation: The operation to perform on the parameter. (like add, multiply, set)

  • value: The value that is used with the operation.

pydantic model ensysmod.schemas.EnergyModelOverrideCreate[source]

Attributes to receive via API on creation of a model parameter override.

field component_name: str [Required]

The name of the component which attribute is overridden.

Constraints:
  • min_length = 1

  • max_length = 255

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

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

field attribute: EnergyModelOverrideAttribute [Required]

The attribute of the component to be overridden.

field operation: EnergyModelOverrideOperation [Required]

The operation of the override. Input should be ‘set’, ‘add’ or ‘multiply’.

field value: float [Required]

The value of the parameter.