ConversionTechnology

Overview

ConversionTechnology describes technologies that convert one carrier into another (for example electricity to heat).

Use Cases

• Implement conversion technologies with project-specific assumptions.

• Provide conversion-related attributes for model build and export.

Examples

The code below shows an example of how to implement a subclass of the ConversionTechnology abstract class. Please read the docstrings carefully as they contain detailed information on required methods and syntax.

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from zen_creator.model import Model

from zen_creator.datasets.datasets import TemplateDataset
from zen_creator.datasets.datasets.metadata import MetaData, SourceInformation
from zen_creator.elements import ConversionTechnology
from zen_creator.utils.attribute import Attribute


class TemplateConversionTechnology(ConversionTechnology):
    """Template class for conversion technologies.

    This template is designed as a starting point for users wishing to implement
    a new conversion technology. Please read the docstrings and comments carefully
    for notes on how to use the template.

    All methods and properties that need to be implemented are marked with`TODO`
    comments. You can search for `TODO` in this file to quickly find all the
    places where you need to make changes.
    """

    name: str = "template_conversion_technology"

    def __init__(self, model: Model, power_unit: str = "MW"):
        super().__init__(model=model, power_unit=power_unit)

    # ---------- Required methods that are called during object construction ----------

    def _set_reference_carrier(self) -> Attribute:
        """
        Return the reference carrier of the technology.

        This method is used to set the self.reference_carrier property when the
        technology is constructed.

        TODO: This method must be implemented. It should return an Attribute object
        containing the reference carrier of the technology.
        """
        return Attribute(name="reference_carrier", default_value=["heat"], element=self)

    def _set_input_carrier(self) -> Attribute:
        """
        Return the input carrier of the technology.

        This method is used to set the self.input_carrier property when the
        technology is constructed.

        TODO: This method must be implemented. It should return an Attribute object
        containing the input carrier of the technology.
        """
        return Attribute(
            name="input_carrier", default_value=["electricity"], element=self
        )

    def _set_output_carrier(self) -> Attribute:
        """
        Return the output carrier of the technology.

        This method is used to set the self.output_carrier property when the
        technology is constructed.

        TODO: This method must be implemented. It should return an Attribute object
        containing the output carrier of the technology.
        """
        return Attribute(name="output_carrier", default_value=["heat"], element=self)

    # ---------- Required methods that are called during object build ----------

    def _set_lifetime(self) -> Attribute:
        """
        Return the lifetime of the technology.

        This method is used to set the self.lifetime property when the
        technology is built.

        TODO: This method must be implemented. It should return an Attribute object
        containing the lifetime of the technology.
        """

        attr = self._lifetime
        return attr.set_data(
            default_value=25,
            source=SourceInformation(
                description="Description of assumption.",
                metadata=MetaData(
                    name="datasource1",
                    title="Study of lifetime of template conversion technology.",
                    author=["ZEN Creator"],
                    publication="ZEN Creator Journal",
                    publication_year=2026,
                    url="",
                ),
            ),
        )

    def _set_conversion_factor(self) -> Attribute:
        """
        Return the conversion factor of the technology.

        This method is used to set the self.conversion_factor property when the
        technology is built.

        TODO: This method must be implemented. It should return an Attribute object
        containing the conversion factor of the technology.
        """
        return Attribute(
            name="conversion_factor",
            default_value=[{"electricity": {"default_value": 1, "unit": "GWh/GWh"}}],
            element=self,
        )

    # ----Example of an optional method for creating an attribute using a dataset ------

    def _set_max_load(self) -> Attribute:
        """
        Return the max load of the technology.

        This method is used to set the self.max_load property when the
        technology is built.

        This method is an example of how to create an attribute using information from
        a dataset. It is not required for all technologies. Use this syntax
        when attributes need to be initialized with data from a dataset.

        Attributes should be returned directly from the dataset method
        "get_<attribute_name>" of the relevant dataset. In this example, we
        assume that the dataset has a method "get_max_load" which returns an
        Attribute object containing the max load of the technology.

        Data processing should be done directly in the dataset classes whenever
        possible, rather than in this method. The main purpose of this method
        is to provide an easily readable map that directs to the relevant
        datasets or datasetcollections.
        """

        attr = TemplateDataset(self.model.config.source_path).get_max_load(element=self)

        return attr

Summary

zen_creator.ConversionTechnology.__init__

Initialize an Element instance.

Constructors

ConversionTechnology.__init__(model: Model, power_unit: str = 'MW')

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.ConversionTechnology(model: Model, power_unit: str = 'MW')

Bases: Technology, ABC

property capex_specific_conversion: Attribute

property conversion_factor: Attribute

property input_carrier: Attribute

property min_full_load_hours_fraction: Attribute

name: str = 'conversion_technology'

property output_carrier: Attribute

set_default_values_conversion_technology()

Initialize internal attributes to default values.

subpath: ClassVar[str] = 'set_conversion_technologies'