topotherm.settings
==================

.. py:module:: topotherm.settings

.. autoapi-nested-parse::

   This file contains all the settings for the optimization problem and should
   be modified and adapted to each case through a .yaml file (see examples).



Classes
-------

.. autoapisummary::

   topotherm.settings.Water
   topotherm.settings.Ground
   topotherm.settings.Temperatures
   topotherm.settings.Piping
   topotherm.settings.Solver
   topotherm.settings.Economics
   topotherm.settings.Settings


Functions
---------

.. autoapisummary::

   topotherm.settings.load


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

.. py:class:: Water(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Water properties for the linearization of piping.


   .. py:attribute:: dynamic_viscosity
      :type:  float
      :value: None



   .. py:attribute:: density
      :type:  float
      :value: None



   .. py:attribute:: heat_capacity_cp
      :type:  float
      :value: None



.. py:class:: Ground(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Ground properties for the linearization of piping.


   .. py:attribute:: thermal_conductivity
      :type:  float
      :value: None



.. py:class:: Temperatures(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Temperatures for the linearization of piping, calculation of
   postprocessing.


   .. py:attribute:: ambient
      :type:  float
      :value: None



   .. py:attribute:: supply
      :type:  float
      :value: None



   .. py:attribute:: return_
      :type:  float
      :value: None



.. py:class:: Piping(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Piping properties for the linearization of piping.


   .. py:attribute:: diameter
      :type:  List[float]
      :value: None



   .. py:attribute:: middle_diameter
      :type:  List[float]
      :value: None



   .. py:attribute:: outer_diameter
      :type:  List[float]
      :value: None



   .. py:attribute:: cost
      :type:  List[float]
      :value: None



   .. py:attribute:: number_diameters
      :type:  int
      :value: None



   .. py:attribute:: max_pr_loss
      :type:  float
      :value: None



   .. py:attribute:: roughness
      :type:  float
      :value: None



   .. py:attribute:: thermal_conductivity
      :type:  float
      :value: None



   .. py:attribute:: depth
      :type:  float
      :value: None



   .. py:method:: check_length()

      Check if the length of diameter, outer_diameter, and cost is
      consistent with the defined number diameters.



.. py:class:: Solver(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Solver properties for the optimization problem. Used for the
   optimization model.


   .. py:attribute:: mip_gap
      :type:  float
      :value: None



   .. py:attribute:: time_limit
      :type:  int
      :value: None



   .. py:attribute:: log
      :type:  str
      :value: None



.. py:class:: Economics(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Economic properties for the optimization problem. Used for the
   optimization model.


   .. py:attribute:: source_price
      :type:  List[List[float]]
      :value: None



   .. py:attribute:: source_c_inv
      :type:  List[float]
      :value: None



   .. py:attribute:: source_c_irr
      :type:  List[float]
      :value: None



   .. py:attribute:: source_lifetime
      :type:  List[float]
      :value: None



   .. py:attribute:: source_max_power
      :type:  List[float]
      :value: None



   .. py:attribute:: source_min_power
      :type:  List[float]
      :value: None



   .. py:attribute:: pipes_c_irr
      :type:  float
      :value: None



   .. py:attribute:: heat_price
      :type:  float
      :value: None



   .. py:attribute:: pipes_lifetime
      :type:  float
      :value: None



.. py:class:: Settings(water = Water(), ground = Ground(), temperatures = Temperatures(), piping = Piping(), solver = Solver(), economics = Economics())

   Bases: :py:obj:`pydantic.BaseModel`


   Class for the settings of the optimization problem which is passed
   to the regression, optimization model, and postprocessing.


   .. py:attribute:: water
      :type:  Water


   .. py:attribute:: ground
      :type:  Ground


   .. py:attribute:: temperatures
      :type:  Temperatures


   .. py:attribute:: piping
      :type:  Piping


   .. py:attribute:: solver
      :type:  Solver


   .. py:attribute:: economics
      :type:  Economics


.. py:function:: load(file_path)

   Load the settings from a yaml file.