EnergySystem

Overview

EnergySystem stores system-level settings and attributes used by the model.

Use Cases

• Configure global model behavior and system assumptions.

• Read, modify, and write the energy_system data structure.

Examples

from zen_creator import EnergySystem

# Typically extended in project-specific implementations.
class MyEnergySystem(EnergySystem):
    pass

Summary

zen_creator.EnergySystem.__init__

Initialize an Element instance.

Constructors

EnergySystem.__init__(model: Model)

Initialize an Element instance.

Parameters:

• model (Model) – The model this element belongs to.

• power_unit (str) – The unit for power values. Defaults to “MW”.

Member Reference

class zen_creator.EnergySystem(model: Model)

Bases: Element, ABC

property carbon_emissions_annual_limit: Attribute

property carbon_emissions_budget: Attribute

property carbon_emissions_cumulative_existing: Attribute

property discount_rate: Attribute

property knowledge_depreciation_rate: Attribute

property knowledge_spillover_rate: Attribute

property market_share_unbounded: Attribute

name: str = 'energy_system'

property price_carbon_emissions: Attribute

property price_carbon_emissions_annual_overshoot: Attribute

property price_carbon_emissions_budget_overshoot: Attribute

property relative_output_path: Path

Get the relative output path for the energy system.

Returns:

The relative path for output files.

Return type:

Path

set_default_values_energy_system()

Initialize all attributes to their default values.

property set_edges: Attribute

property set_nodes: Attribute

write() → None

Write the energy system folder.

This method writes all files in the energy system folder of the model. It overrides the standard write method from the element class to also save the unit files.