:py:mod:`sentier_peakachu.model`
================================

.. py:module:: sentier_peakachu.model


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   sentier_peakachu.model.BottomModel
   sentier_peakachu.model.ElectricityMixModel
   sentier_peakachu.model.ElectricitySourceModel
   sentier_peakachu.model.TopModel




.. py:class:: BottomModel


   Bases: :py:obj:`sentier_data_tools.SentierModel`


.. py:class:: ElectricityMixModel


   Bases: :py:obj:`TopModel`

   Model to calculate the the emission factor for location and time.

   .. py:attribute:: aliases

      

   .. py:attribute:: provides

      

   .. py:method:: calculate_impact(market_shares: pandas.Series) -> float


   .. py:method:: calculate_market_mix(df_mixes: pandas.DataFrame) -> pandas.DataFrame


   .. py:method:: calculate_technology_emission_factor(product_iri: sentier_data_tools.ProductIRI) -> float


   .. py:method:: get_bonsai_emission_factor(product_iri: sentier_data_tools.ProductIRI) -> float


   .. py:method:: get_model_data() -> pandas.DataFrame


   .. py:method:: prepare() -> None


   .. py:method:: run(abbreviate_iris: bool = True) -> tuple[list[sentier_data_tools.Demand], list[sentier_data_tools.Flow]]



.. py:class:: ElectricitySourceModel


   Bases: :py:obj:`BottomModel`

   Model to calculate the average emission factor of a specific electricity generating technology.

   .. py:attribute:: aliases

      

   .. py:attribute:: provides

      

   .. py:method:: calculate_average_source_emission_factor(df: pandas.DataFrame) -> pandas.DataFrame


   .. py:method:: get_model_data() -> pandas.DataFrame


   .. py:method:: prepare() -> None


   .. py:method:: run(abbreviate_iris: bool = True) -> tuple[list[sentier_data_tools.Demand], list[sentier_data_tools.Flow]]



.. py:class:: TopModel


   Bases: :py:obj:`sentier_data_tools.SentierModel`