Merge branch 'dev'

Author: fwitte

docs/scripts/generate_tespy_data_module.py

@@ -12,7 +12,7 @@ def get_char_data(filename):
     path = resource_filename('tespy.data', filename + '.json')
 
     with open(path) as f:
-        data = json.loads(f.read())
+        data = json.load(f)
 
     return data
 

docs/whats_new.rst

@@ -3,6 +3,7 @@ What's New
 
 Discover notable new features and improvements in each release
 
+.. include::  whats_new/v0-7-4.rst
 .. include::  whats_new/v0-7-3.rst
 .. include::  whats_new/v0-7-2.rst
 .. include::  whats_new/v0-7-1.rst

docs/whats_new/v0-7-4.rst

@@ -0,0 +1,41 @@
+v0.7.4 - Newton's Nature (April, 30, 2024)
+++++++++++++++++++++++++++++++++++++++++++
+
+Bug Fixes
+#########
+- :code:`Component` and :code:`FluidWrapper` objects are now available for the
+  :code:`load_network` function via the :code:`@component_registry` and
+  :code:`@wrapper_registry` decorators. E.g. if you are using custom components
+  you can decorate them with the :code:`@component_registry` and the load a
+  :code:`Network` with those components without needing to adjust the source
+  code of the :code:`load_network` function
+  (`PR #510 <https://github.com/oemof/tespy/pull/510>`__).
+
+  .. code-block:: python
+
+      >>> from tespy.components.component import component_registry
+      >>> from tespy.components import Source, Sink, SimpleHeatExchanger
+      >>> from tespy.connections import Connection
+      >>> from tespy.networks import Network, load_network
+
+      >>> @component_registry
+      ... class MyComponent(SimpleHeatExchanger):
+      ...     pass
+
+      >>> c = component_registry.items["MyComponent"]("I am a component")
+      >>> c.label
+      'I am a component'
+
+      >>> nwk = Network()
+      >>> c1 = Connection(Source("source"), "out1", c, "in1", label="1")
+      >>> c2 = Connection(c, "out1", Sink("sink"), "in1", label="2")
+      >>> nwk.add_conns(c1, c2)
+      >>> nwk.export("exported_nwk")
+      >>> nwk = load_network("exported_nwk")
+      >>> nwk.comps.loc["I am a component", "comp_type"]
+      'MyComponent'
+
+Contributors
+############
+- Francesco Witte (`@fwitte <https://github.com/fwitte>`__)
+- `@jfreissmann <https://github.com/jfreissmann>`__

pyproject.toml

@@ -25,7 +25,7 @@ exclude = ["docs/_build"]
 
 [project]
 name = "tespy"
-version = "0.7.3"
+version = "0.7.4"
 description = "Thermal Engineering Systems in Python (TESPy)"
 readme = "README.rst"
 authors = [

src/tespy/__init__.py

@@ -3,7 +3,7 @@
 import os
 
 __datapath__ = os.path.join(importlib.resources.files("tespy"), "data")
-__version__ = '0.7.3 - Newton\'s Nature'
+__version__ = '0.7.4 - Newton\'s Nature'
 
 # tespy data and connections import
 from . import connections  # noqa: F401

src/tespy/components/basics/cycle_closer.py

@@ -13,11 +13,11 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 
-# %%
-
 
+@component_registry
 class CycleCloser(Component):
     r"""
     Component for closing cycles.

src/tespy/components/basics/sink.py

@@ -13,8 +13,10 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 
 
+@component_registry
 class Sink(Component):
     r"""
     A flow drains in a Sink.

src/tespy/components/basics/source.py

@@ -13,8 +13,10 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 
 
+@component_registry
 class Source(Component):
     r"""
     A flow originates from a Source.

src/tespy/components/basics/subsystem_interface.py

@@ -12,9 +12,11 @@
 """
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 
 
+@component_registry
 class SubsystemInterface(Component):
     r"""
     The subsystem interface does not change fluid properties.

src/tespy/components/combustion/base.py

@@ -16,6 +16,7 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools import logger
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.document_models import generate_latex_eq
@@ -27,6 +28,7 @@
 from tespy.tools.helpers import fluidalias_in_list
 
 
+@component_registry
 class CombustionChamber(Component):
     r"""
     The class CombustionChamber is parent class of all combustion components.

src/tespy/components/combustion/diabatic.py

@@ -14,12 +14,14 @@
 import numpy as np
 
 from tespy.components import CombustionChamber
+from tespy.components.component import component_registry
 from tespy.tools import logger
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.document_models import generate_latex_eq
 from tespy.tools.fluid_properties import h_mix_pT
 
 
+@component_registry
 class DiabaticCombustionChamber(CombustionChamber):
     r"""
     The class CombustionChamber is parent class of all combustion components.

src/tespy/components/combustion/engine.py

@@ -10,19 +10,21 @@
 
 SPDX-License-Identifier: MIT
 """
+
 import numpy as np
 
 from tespy.components.combustion.base import CombustionChamber
+from tespy.components.component import component_registry
 from tespy.tools import logger
 from tespy.tools.data_containers import ComponentCharacteristics as dc_cc
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
-from tespy.tools.fluid_properties import h_mix_pT
 from tespy.tools.fluid_properties import s_mix_ph
 from tespy.tools.fluid_properties import s_mix_pT
 
 
+@component_registry
 class CombustionEngine(CombustionChamber):
     r"""
     An internal combustion engine supplies power and heat cogeneration.

src/tespy/components/component.py

@@ -33,6 +33,15 @@
 from tespy.tools.helpers import newton_with_kwargs
 
 
+def component_registry(type):
+    component_registry.items[type.__name__] = type
+    return type
+
+
+component_registry.items = {}
+
+
+@component_registry
 class Component:
     r"""
     Class Component is the base class of all TESPy components.

src/tespy/components/heat_exchangers/base.py

@@ -13,6 +13,7 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools.data_containers import ComponentCharacteristics as dc_cc
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.data_containers import GroupedComponentCharacteristics as dc_gcc
@@ -21,6 +22,7 @@
 from tespy.tools.fluid_properties import s_mix_ph
 
 
+@component_registry
 class HeatExchanger(Component):
     r"""
     Class for counter current heat exchanger.

src/tespy/components/heat_exchangers/condenser.py

@@ -13,6 +13,7 @@
 
 import numpy as np
 
+from tespy.components.component import component_registry
 from tespy.components.heat_exchangers.base import HeatExchanger
 from tespy.tools.data_containers import ComponentCharacteristics as dc_cc
 from tespy.tools.data_containers import ComponentProperties as dc_cp
@@ -23,6 +24,7 @@
 from tespy.tools.fluid_properties import h_mix_pQ
 
 
+@component_registry
 class Condenser(HeatExchanger):
     r"""
     A Condenser cools a fluid until it is in liquid state.

src/tespy/components/heat_exchangers/desuperheater.py

@@ -11,12 +11,14 @@
 SPDX-License-Identifier: MIT
 """
 
+from tespy.components.component import component_registry
 from tespy.components.heat_exchangers.base import HeatExchanger
 from tespy.tools.document_models import generate_latex_eq
 from tespy.tools.fluid_properties import dh_mix_dpQ
 from tespy.tools.fluid_properties import h_mix_pQ
 
 
+@component_registry
 class Desuperheater(HeatExchanger):
     r"""
     The Desuperheater cools a fluid to the saturated gas state.

src/tespy/components/heat_exchangers/parabolic_trough.py

@@ -11,15 +11,14 @@
 SPDX-License-Identifier: MIT
 """
 
-import numpy as np
-
+from tespy.components.component import component_registry
 from tespy.components.heat_exchangers.simple import SimpleHeatExchanger
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.data_containers import GroupedComponentProperties as dc_gcp
-from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
 
 
+@component_registry
 class ParabolicTrough(SimpleHeatExchanger):
     r"""
     The ParabolicTrough calculates heat output from irradiance.

src/tespy/components/heat_exchangers/simple.py

@@ -16,6 +16,7 @@
 import numpy as np
 
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools import logger
 from tespy.tools.data_containers import ComponentCharacteristics as dc_cc
 from tespy.tools.data_containers import ComponentProperties as dc_cp
@@ -27,6 +28,7 @@
 from tespy.tools.helpers import convert_to_SI
 
 
+@component_registry
 class SimpleHeatExchanger(Component):
     r"""
     A basic heat exchanger representing a heat source or heat sink.

src/tespy/components/heat_exchangers/solar_collector.py

@@ -11,15 +11,14 @@
 SPDX-License-Identifier: MIT
 """
 
-import numpy as np
-
+from tespy.components.component import component_registry
 from tespy.components.heat_exchangers.simple import SimpleHeatExchanger
 from tespy.tools.data_containers import ComponentProperties as dc_cp
 from tespy.tools.data_containers import GroupedComponentProperties as dc_gcp
-from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
 
 
+@component_registry
 class SolarCollector(SimpleHeatExchanger):
     r"""
     The solar collector calculates heat output from irradiance.

src/tespy/components/nodes/base.py

@@ -10,12 +10,12 @@
 SPDX-License-Identifier: MIT
 """
 
-import numpy as np
-
 from tespy.components.component import Component
+from tespy.components.component import component_registry
 from tespy.tools.document_models import generate_latex_eq
 
 
+@component_registry
 class NodeBase(Component):
     """Class NodeBase is parent class for all components of submodule nodes."""
 

src/tespy/components/nodes/droplet_separator.py

@@ -10,12 +10,15 @@
 
 SPDX-License-Identifier: MIT
 """
+
+from tespy.components.component import component_registry
 from tespy.components.nodes.base import NodeBase
 from tespy.tools.document_models import generate_latex_eq
 from tespy.tools.fluid_properties import dh_mix_dpQ
 from tespy.tools.fluid_properties import h_mix_pQ
 
 
+@component_registry
 class DropletSeparator(NodeBase):
     r"""
     Separate liquid phase from gas phase of a single fluid.

src/tespy/components/nodes/drum.py

@@ -12,10 +12,12 @@
 
 import numpy as np
 
+from tespy.components.component import component_registry
 from tespy.components.nodes.droplet_separator import DropletSeparator
 from tespy.tools.fluid_properties import h_mix_pQ
 
 
+@component_registry
 class Drum(DropletSeparator):
     r"""
     A drum separates saturated gas from saturated liquid.

src/tespy/components/nodes/merge.py

@@ -12,12 +12,14 @@
 
 import numpy as np
 
+from tespy.components.component import component_registry
 from tespy.components.nodes.base import NodeBase
 from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
 from tespy.tools.fluid_properties import s_mix_pT
 
 
+@component_registry
 class Merge(NodeBase):
     r"""
     Class for merge points with multiple inflows and one outflow.

src/tespy/components/nodes/separator.py

@@ -10,8 +10,7 @@
 SPDX-License-Identifier: MIT
 """
 
-import numpy as np
-
+from tespy.components.component import component_registry
 from tespy.components.nodes.base import NodeBase
 from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
@@ -21,6 +20,7 @@
 # from tespy.tools.fluid_properties import dT_mix_ph_dfluid
 
 
+@component_registry
 class Separator(NodeBase):
     r"""
     A separator separates fluid components from a mass flow.

src/tespy/components/nodes/splitter.py

@@ -10,13 +10,13 @@
 SPDX-License-Identifier: MIT
 """
 
-import numpy as np
-
+from tespy.components.component import component_registry
 from tespy.components.nodes.base import NodeBase
 from tespy.tools.data_containers import SimpleDataContainer as dc_simple
 from tespy.tools.document_models import generate_latex_eq
 
 
+@component_registry
 class Splitter(NodeBase):
     r"""
     Split up a mass flow in parts of identical enthalpy and fluid composition.

src/tespy/components/piping/pipe.py

@@ -10,9 +10,11 @@
 SPDX-License-Identifier: MIT
 """
 
+from tespy.components.component import component_registry
 from tespy.components.heat_exchangers.simple import SimpleHeatExchanger
 
 
+@component_registry
 class Pipe(SimpleHeatExchanger):
     r"""
     The Pipe is a subclass of a SimpleHeatExchanger.