tespy 0.4.3.post2__tar.gz → 0.4.3.post4__tar.gz

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: TESPy
-Version: 0.4.3.post2
+Version: 0.4.3.post4
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: https://github.com/oemof/tespy
 Author: Francesco Witte

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/analyses/exergy.rst

@@ -48,7 +48,8 @@ potential exergy are neglected and therefore not considered as well.
     * - :code:`ex_physical`, :code:`Ex_physical`
       - (specific) physical exergy
       - :math:`e^\mathrm{PH}`, :math:`E^\mathrm{PH}`
-      - due to the deviation of the temperature and pressure of the system from those of the environment
+      - due to the deviation of the temperature and pressure of the system from
+        those of the environment
     * - :code:`ex_therm`, :code:`Ex_therm`
       - (specific) thermal exergy
       - :math:`e^\mathrm{T}`, :math:`E^\mathrm{T}`
@@ -60,19 +61,24 @@ potential exergy are neglected and therefore not considered as well.
     * - :code:`E_P`
       - product exergy
       - :math:`\dot{E}_\mathrm{P}`
-      - represents the desired result(expressed in terms of exergy) generated by the system being considered represents the resources (expressed in terms of exergy)
+      - represents the desired result(expressed in terms of exergy) generated
+        by the system being considered represents the resources (expressed in
+        terms of exergy)
     * - :code:`E_F`
       - fuel exergy
       - :math:`\dot{E}_\mathrm{F}`
-      - represents the resources (expressed in terms of exergy) expended to provide the product exergy
+      - represents the resources (expressed in terms of exergy) expended to
+        provide the product exergy
     * - :code:`E_D`
       - exergy destruction
       - :math:`\dot{E}_\mathrm{D}`
-      - thermodynamic inefficienies associated with the irreversibilities (entropy generation) within the system boundaries
+      - thermodynamic inefficienies associated with the irreversibilities
+        (entropy generation) within the system boundaries
     * - :code:`E_L`
       - exergy loss
       - :math:`\dot{E}_\mathrm{L}`
-      - thermodynamic inefficienies associated with the transfer of exergy through material and energy streams to the surroundings
+      - thermodynamic inefficienies associated with the transfer of exergy
+        through material and energy streams to the surroundings
     * - :code:`epsilon`
       - exergetic efficiency
       - :math:`\varepsilon`
@@ -80,11 +86,13 @@ potential exergy are neglected and therefore not considered as well.
     * - :code:`y_D,k`
       - exergy destruction ratio
       - :math:`y_\mathrm{D}`
-      - rate of exergy destruction in a component compared to the exergy rate of the fuel provided to the overall system
+      - rate of exergy destruction in a component compared to the exergy rate
+        of the fuel provided to the overall system
     * - :code:`y*_D,k`
       - exergy destruction ratio
       - :math:`y^*_\mathrm{D}`
-      - rate of exergy destruction in a component compared to the total exergy destruction rate within the system
+      - rate of exergy destruction in a component compared to the total exergy
+        destruction rate within the system
 
 .. note::
 
@@ -99,6 +107,11 @@ In this short tutorial, an exergy analysis is carried out for the Solar Energy
 Generating System (SEGS). The full python script is available on GitHub in
 an individual repository: https://github.com/fwitte/SEGS_exergy.
 
+Two other full code examples are to be found at:
+
+- Supercritical CO\ :sub:`2` power cycle: https://github.com/fwitte/sCO2_exergy
+- Refrigeration machine: https://github.com/fwitte/refrigeration_cycle_exergy
+
 The SEGS consists of three main systems, the solar field, the steam cycle and
 the cooling water system. In the solar field Therminol VP1 is used as heat
 transfer liquid. In the steam generator and reheater the TVP1 is cooled down to

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/tespy_modules/networks.rst

@@ -577,8 +577,8 @@ have further options:
 - Save the results in structure of .csv-files (:code:`save()`).
 - Generate fluid property diagrams with an external tool.
 
-Model documentation
-^^^^^^^^^^^^^^^^^^^
+Automatic model documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Using the automatic TESPy model documentation you can create an overview of
 all input parameters, specifications and equations as well as characteristics
 applied in LaTeX format. This enables high
@@ -593,14 +593,36 @@ optional arguments to the method:
 
 - :code:`path`: Basepath, where the LaTeX data and figures are exported to.
 - :code:`filename`: Filename of the report.
-- :code:`draft`: Show or hide the first part of the Software Information
-  section.
+- :code:`rpt_formatter`: A formatting dictionary, for a sample see below.
 
 .. code-block:: python
 
     from tespy.tools import document_model
 
-    document_model(mynetwork)
+    rpt_params = {
+        'latex_body': True,  # adds LaTeX body to compile report out of the box
+        'include_results': True,  # include parameter specification and results
+        'HeatExchanger': {  # for components of class HeatExchanger
+            'params': ['Q', 'ttd_l', 'ttd_u', 'pr1', 'pr2']},  # change columns displayed
+        'Condenser': {  # for components of class HeatExchanger
+            'params': ['Q', 'ttd_l', 'ttd_u', 'pr1', 'pr2']
+            'float_fmt': '{:,.2f}'},  # change float format of data
+        'Connection': {  # for Connection instances
+            'p': {'float_fmt': '{:,.4f}'},  # change float format of pressure
+            's': {'float_fmt': '{:,.4f}'},
+            'h': {'float_fmt': '{:,.2f}'},
+            'params': ['m', 'p', 'h', 's']  # list results of mass flow, ...
+            'fluid': {'include_results': False}  # exclude results of fluid composition
+        },
+        'include_results': True,  # include results
+        'draft': False  # disable draft mode
+    }
+    document_model(mynetwork, rpt_formatter=rpt_params)
+
+.. note::
+
+    Specified values are displayed in any case. The selection of which
+    parameters to show and which to exclude only applies to results.
 
 After having exported the LaTeX code, you can simply use :code:`\input{}`
 in your main LaTeX document to include the documentation of your model. In
@@ -613,6 +635,7 @@ order to compile correctly you need to load the following LaTeX packages:
    -  amsmath
    -  units
    -  cleveref
+   -  longtable
 
 For generating different file formats, like markdown, html or
 restructuredtext, you could try the `pandoc <https://pandoc.org/>`_ library.

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/tespy_modules.rst

@@ -16,6 +16,7 @@ simulation with TESPy.
     :local:
     :backlinks: top
 
+.. _tespy_modules_network_label:
 .. include:: tespy_modules/networks.rst
 .. _using_tespy_components_label:
 .. include:: tespy_modules/components.rst

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/tutorials_examples/tutorial_heat_pump.rst

@@ -293,7 +293,7 @@ pressure ratios on hot and cold side as well as the lower terminal temperature
 difference. We use the hot side pressure ratio and the lower terminal
 temperature (similar to pinch point layout for waste heat steam generators)
 difference as design parameters and choose zeta as well as the area independent
-heat transition coefficient as its offdesign parameters.
+heat transfer coefficient as its offdesign parameters.
 
 On top of that, the characteristic function of the evaporator should follow the
 default characteristic line of 'EVAPORATING FLUID' on the cold side and the

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/whats_new/v0-4-3-001.rst

@@ -11,7 +11,7 @@ Other Changes
   :code:`key in dictionary.keys()` in boolean operations
   (`PR #264 <https://github.com/oemof/tespy/pull/264>`_).
 - Rename GitHub branches: master to main
-  (`Issue #266 <https://github.com/oemof/tespy/issues/265>`_).
+  (`Issue #266 <https://github.com/oemof/tespy/issues/266>`_).
 
 Contributors
 ############

TESPy-0.4.3.post4/docs/whats_new/v0-4-3-003.rst

@@ -0,0 +1,18 @@
+v0.4.3-003 - Grassmann's Graph (May, 17, 2021)
+++++++++++++++++++++++++++++++++++++++++++++++
+
+Documentation
+#############
+- Fix typos in the HeatExchanger classes API docs.
+- Add two more examples for exergy analysis setups.
+
+Other Changes
+#############
+- Make it possible to include results in automatic model report, for more
+  information see the corresponding section in the documentation:
+  :ref:`TESPy Networks Postprocessing <tespy_modules_network_label>`
+  (`PR #267 <https://github.com/oemof/tespy/pull/267>`_).
+
+Contributors
+############
+- Francesco Witte (`@fwitte <https://github.com/fwitte>`_)

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/docs/whats_new.rst

@@ -8,6 +8,7 @@ Discover noteable new features and improvements in each release
     :local:
     :backlinks: top
 
+.. include::  whats_new/v0-4-3-003.rst
 .. include::  whats_new/v0-4-3-001.rst
 .. include::  whats_new/v0-4-3.rst
 .. include::  whats_new/v0-4-2.rst

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/setup.py

@@ -25,7 +25,7 @@ def read(*names, **kwargs):
 
 setup(
     name='TESPy',
-    version='0.4.3-002',
+    version='0.4.3-004',
     license='MIT',
     description='Thermal Engineering Systems in Python (TESPy)',
     long_description='%s' % (
@@ -67,7 +67,7 @@ setup(
         'CoolProp>=6.4,<7',
         'matplotlib>=3.2.1,<4',
         'numpy>=1.13.3,<2',
-        'pandas>=0.19.2,!=1.0.0,<2',
+        'pandas>=1.20.0,<2',
         'scipy>=0.19.1,<2',
         'tabulate>=0.8.2,<0.9'
     ],

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/TESPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: TESPy
-Version: 0.4.3.post2
+Version: 0.4.3.post4
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: https://github.com/oemof/tespy
 Author: Francesco Witte

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/TESPy.egg-info/SOURCES.txt

@@ -26,7 +26,6 @@ ci/templates/.appveyor.yml
 ci/templates/.travis.yml
 ci/templates/tox.ini
 docs/api.rst
-docs/bibtex.json
 docs/conf.py
 docs/developing_tespy.rst
 docs/first_steps.rst
@@ -154,6 +153,7 @@ docs/whats_new/v0-4-0.rst
 docs/whats_new/v0-4-1.rst
 docs/whats_new/v0-4-2.rst
 docs/whats_new/v0-4-3-001.rst
+docs/whats_new/v0-4-3-003.rst
 docs/whats_new/v0-4-3.rst
 src/TESPy.egg-info/PKG-INFO
 src/TESPy.egg-info/SOURCES.txt

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/TESPy.egg-info/requires.txt

@@ -1,7 +1,7 @@
 CoolProp<7,>=6.4
 matplotlib<4,>=3.2.1
 numpy<2,>=1.13.3
-pandas!=1.0.0,<2,>=0.19.2
+pandas<2,>=1.20.0
 scipy<2,>=0.19.1
 tabulate<0.9,>=0.8.2
 

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8
 
-__version__ = '0.4.3-002 - Grassmann\'s Graph'
+__version__ = '0.4.3-004 - Grassmann\'s Graph'
 
 # tespy data and connections import
 from . import connections  # noqa: F401

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/component.py

@@ -321,6 +321,10 @@ class Component:
         self.vars = {}
         self.num_vars = 0
         self.constraints = OrderedDict(self.get_mandatory_constraints().copy())
+        self.prop_specifications = {}
+        self.var_specifications = {}
+        self.group_specifications = {}
+        self.char_specifications = {}
         self.__dict__.update(self.constraints)
 
         for constraint in self.constraints.values():
@@ -334,8 +338,13 @@ class Component:
                     self.num_vars += 1
                     self.vars[data] = key
 
+                self.prop_specifications[key] = val.is_set
+                self.var_specifications[key] = val.is_var
+
             # component characteristics
             elif isinstance(val, dc_cc):
+                if data.func is not None:
+                    self.char_specifications[key] = val.is_set
                 if data.char_func is None:
                     try:
                         data.char_func = ldc(
@@ -345,6 +354,8 @@ class Component:
 
             # component characteristics
             elif isinstance(val, dc_cm):
+                if data.func is not None:
+                    self.char_specifications[key] = val.is_set
                 if data.char_func is None:
                     try:
                         data.char_func = ldc(
@@ -371,12 +382,16 @@ class Component:
                     val.set_attr(is_set=False)
                 else:
                     val.set_attr(is_set=False)
+                self.group_specifications[key] = val.is_set
+
+            # grouped component characteristics
+            elif isinstance(val, dc_gcc):
+                self.group_specifications[key] = val.is_set
 
             # component properties
             if data.is_set and data.func is not None:
                 self.num_eq += data.num_eq
 
-            # print(key, data.is_set, self.num_eq)
         # set up Jacobian matrix and residual vector
         self.jacobian = np.zeros((
             self.num_eq,

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/heat_exchangers/condenser.py

@@ -116,11 +116,11 @@ class Condenser(HeatExchanger):
         temprature of condensing fluid) :math:`ttd_\mathrm{u}/\text{K}`.
 
     kA : float, dict
-        Area independent heat transition coefficient,
+        Area independent heat transfer coefficient,
         :math:`kA/\frac{\text{W}}{\text{K}}`.
 
     kA_char : tespy.tools.data_containers.DataContainerSimple
-        Area independent heat transition coefficient characteristic.
+        Area independent heat transfer coefficient characteristic.
 
     kA_char1 : tespy.tools.characteristics.CharLine, dict
         Characteristic line for hot side heat transfer coefficient.
@@ -219,7 +219,7 @@ class Condenser(HeatExchanger):
             'kA': dc_cp(
                 min_val=0, num_eq=1, func=self.kA_func, latex=self.kA_func_doc,
                 deriv=self.kA_deriv),
-            'td_log': dc_cp(min_val=0),
+            'td_log': dc_cp(min_val=0, func='dummy'),
             'ttd_u': dc_cp(
                 min_val=0, num_eq=1, func=self.ttd_u_func,
                 deriv=self.ttd_u_deriv, latex=self.ttd_u_func_doc),

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/heat_exchangers/desuperheater.py

@@ -101,7 +101,7 @@ class Desuperheater(HeatExchanger):
         Upper terminal temperature difference :math:`ttd_\mathrm{u}/\text{K}`.
 
     kA : float, dict
-        Area independent heat transition coefficient,
+        Area independent heat transfer coefficient,
         :math:`kA/\frac{\text{W}}{\text{K}}`.
 
     kA_char1 : tespy.tools.characteristics.CharLine, dict

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/heat_exchangers/heat_exchanger.py

@@ -110,11 +110,11 @@ class HeatExchanger(Component):
         Upper terminal temperature difference :math:`ttd_\mathrm{u}/\text{K}`.
 
     kA : float, dict
-        Area independent heat transition coefficient,
+        Area independent heat transfer coefficient,
         :math:`kA/\frac{\text{W}}{\text{K}}`.
 
     kA_char : dict
-        Area independent heat transition coefficient characteristic.
+        Area independent heat transfer coefficient characteristic.
 
     kA_char1 : tespy.tools.characteristics.CharLine, dict
         Characteristic line for hot side heat transfer coefficient.
@@ -201,7 +201,7 @@ class HeatExchanger(Component):
             'kA': dc_cp(
                 min_val=0, num_eq=1, func=self.kA_func, latex=self.kA_func_doc,
                 deriv=self.kA_deriv),
-            'td_log': dc_cp(min_val=0),
+            'td_log': dc_cp(min_val=0, func='dummy'),
             'ttd_u': dc_cp(
                 min_val=0, num_eq=1, func=self.ttd_u_func,
                 deriv=self.ttd_u_deriv, latex=self.ttd_u_func_doc),

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/heat_exchangers/heat_exchanger_simple.py

@@ -116,7 +116,7 @@ class HeatExchangerSimple(Component):
         used.
 
     kA : float, dict, :code:`"var"`
-        Area independent heat transition coefficient,
+        Area independent heat transfer coefficient,
         :math:`kA/\frac{\text{W}}{\text{K}}`.
 
     kA_char : tespy.tools.characteristics.CharLine, dict

{TESPy-0.4.3.post2 → TESPy-0.4.3.post4}/src/tespy/components/piping/pipe.py

@@ -94,7 +94,7 @@ class Pipe(HeatExchangerSimple):
         used.
 
     kA : float, dict, :code:`"var"`
-        Area independent heat transition coefficient,
+        Area independent heat transfer coefficient,
         :math:`kA/\frac{\text{W}}{\text{K}}`.
 
     kA_char : tespy.tools.characteristics.CharLine, dict