topotherm.settings

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

Water	Water properties for the linearization of piping.
Ground	Ground properties for the linearization of piping.
Temperatures	Temperatures for the linearization of piping, calculation of
Piping	Piping properties for the linearization of piping.
Solver	Solver properties for the optimization problem. Used for the
Economics	Economic properties for the optimization problem. Used for the
Settings	Class for the settings of the optimization problem which is passed

Functions

load(file_path)

Load the settings from a yaml file.

Module Contents

class topotherm.settings.Water(/, **data)

Bases: pydantic.BaseModel

Water properties for the linearization of piping.

Parameters:

data (Any)

dynamic_viscosity: float = None

density: float = None

heat_capacity_cp: float = None

class topotherm.settings.Ground(/, **data)

Bases: pydantic.BaseModel

Ground properties for the linearization of piping.

Parameters:

data (Any)

thermal_conductivity: float = None

class topotherm.settings.Temperatures(/, **data)

Bases: pydantic.BaseModel

Temperatures for the linearization of piping, calculation of postprocessing.

Parameters:

data (Any)

ambient: float = None

supply: float = None

return_: float = None

class topotherm.settings.Piping(/, **data)

Bases: pydantic.BaseModel

Piping properties for the linearization of piping.

Parameters:

data (Any)

diameter: List[float] = None

middle_diameter: List[float] = None

outer_diameter: List[float] = None

cost: List[float] = None

number_diameters: int = None

max_pr_loss: float = None

roughness: float = None

thermal_conductivity: float = None

depth: float = None

check_length()

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

class topotherm.settings.Solver(/, **data)

Bases: pydantic.BaseModel

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

Parameters:

data (Any)

mip_gap: float = None

time_limit: int = None

log: str = None

class topotherm.settings.Economics(/, **data)

Bases: pydantic.BaseModel

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

Parameters:

data (Any)

source_price: List[List[float]] = None

source_c_inv: List[float] = None

source_c_irr: List[float] = None

source_lifetime: List[float] = None

source_max_power: List[float] = None

source_min_power: List[float] = None

pipes_c_irr: float = None

heat_price: float = None

pipes_lifetime: float = None

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

Bases: pydantic.BaseModel

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

Parameters:

• water (Water)

• ground (Ground)

• temperatures (Temperatures)

• piping (Piping)

• solver (Solver)

• economics (Economics)

water: Water

ground: Ground

temperatures: Temperatures

piping: Piping

solver: Solver

economics: Economics

topotherm.settings.load(file_path)

Load the settings from a yaml file.

Parameters:

file_path (Union[str, os.PathLike[str]])

Return type:

Settings