Excel data

All components

For all energy components, these data can be provided via the REST API, or as excel files for easy access. If provided as excel files, the number and the name of the columns must correspond to the regions defined in the dataset. For capacities and full load hours, there should be exactly one row. For operation rates, the number of rows must correspond to the number of time steps defined in the dataset.

Examples can be found here.

Fix Capacity

The following attributes are available for fix capacities:

pydantic model ensysmod.schemas.CapacityFixCreate

Attributes to receive via API on creation of a CapacityFix.

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

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

field capacity_fix: float [Required]

Fixed capacity for a component in a specific region.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Max Capacity

The following attributes are available for maximum capacities:

pydantic model ensysmod.schemas.CapacityMaxCreate

Attributes to receive via API on creation of a CapacityMax.

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

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

field capacity_max: float [Required]

Maximum capacity for a component in a specific region.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Min Capacity

The following attributes are available for minimum capacities:

pydantic model ensysmod.schemas.CapacityMinCreate

Attributes to receive via API on creation of a CapacityMin.

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

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

field capacity_min: float [Required]

Minimum capacity for a component in a specific region.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Fix Operation Rate

The following attributes are available for fix operation rate:

pydantic model ensysmod.schemas.OperationRateFixCreate

Attributes to receive via API on creation of a OperationRateFix.

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

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

field operation_rate_fix: list[NonNegativeFloat] [Required]

Fixed operation rate for a component in a specific region.

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Max Operation Rate

The following attributes are available for maximum operation rate:

pydantic model ensysmod.schemas.OperationRateMaxCreate

Attributes to receive via API on creation of a OperationRateMax.

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

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

field operation_rate_max: list[NonNegativeFloat] [Required]

Maximum operation rate for a component in a specific region.

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Max Yearly Full Load Hours

The following attributes are available for maximum yearly full load hours:

pydantic model ensysmod.schemas.YearlyFullLoadHoursMaxCreate

Attributes to receive via API on creation of a YearlyFullLoadHoursMax.

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

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

field yearly_full_load_hours_max: float [Required]

Maximum yearly full load hour for a component in a region.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Min Yearly Full Load Hours

The following attributes are available for minimum yearly full load hours:

pydantic model ensysmod.schemas.YearlyFullLoadHoursMinCreate

Attributes to receive via API on creation of a YearlyFullLoadHoursMin.

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

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

field yearly_full_load_hours_min: float [Required]

YearlyFullLoadHoursMin for a component in a region.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

field region_to_name: str | None = None

Optional region to name, if needed.

Constraints:

• min_length = 1

• max_length = 255

Transmission components

Additionaly, transmission distances and losses can also be provided for transmission components, via REST API or as excel files. If provided as excel files, the number and the name of rows and columns must correspond to the regions defined in the dataset.

Examples can be found here.

Transmission Distance

The following attributes are available for transmission distances:

pydantic model ensysmod.schemas.TransmissionDistanceCreate

Attributes to receive via API on creation of an TransmissionDistance.

field region_to_name: str [Required]

The name of the target region.

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 distance: float [Required]

Distance between two regions in unit of dataset.

Constraints:

• ge = 0

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255

Transmission Loss

The following attributes are available for transmission losses:

pydantic model ensysmod.schemas.TransmissionLossCreate

Attributes to receive via API on creation of an TransmissionLoss.

field region_to_name: str [Required]

The name of the target region.

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 loss: float [Required]

Relative loss per length unit of energy transmission.

Constraints:

• ge = 0

• le = 1

field ref_dataset: int [Required]

The ID of the referenced dataset. Current dataset is used as default.

Constraints:

• gt = 0

field component_name: str [Required]

The name of the component.

Constraints:

• min_length = 1

• max_length = 255

field region_name: str [Required]

The name of the region.

Constraints:

• min_length = 1

• max_length = 255