tespy 0.3.1__tar.gz → 0.3.3__tar.gz

{TESPy-0.3.1 → TESPy-0.3.3}/PKG-INFO

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

{TESPy-0.3.1 → TESPy-0.3.3}/README.rst

@@ -41,11 +41,11 @@ https://guides.github.com/activities/hello-world/
     :target: https://readthedocs.org/projects/tespy
     :alt: Documentation Status
 
-.. |travis| image:: https://api.travis-ci.org/oemof/tespy.svg?branch=dev
+.. |travis| image:: https://api.travis-ci.org/oemof/tespy.svg?branch=master
     :alt: Travis-CI Build Status
     :target: https://travis-ci.org/oemof/tespy
 
-.. |coveralls| image:: https://coveralls.io/repos/oemof/tespy/badge.svg?branch=dev&service=github
+.. |coveralls| image:: https://coveralls.io/repos/oemof/tespy/badge.svg?branch=master&service=github
     :alt: Coverage Status
     :target: https://coveralls.io/r/oemof/tespy
 

{TESPy-0.3.1 → TESPy-0.3.3}/docs/tespy_modules/subsystems.rst

@@ -52,6 +52,7 @@ Create a file, e.g. :code:`mysubsystems.py` and add the following lines:
     from tespy.components import subsystem, heat_exchanger, drum
     from tespy.connections import connection
 
+
     class waste_heat_steam_generator(subsystem):
         """Class documentation"""
 
@@ -64,18 +65,18 @@ Create a file, e.g. :code:`mysubsystems.py` and add the following lines:
 
         def create_conns(self):
             """Define the subsystem's connections."""
-            self.conns['eco_dr'] = connection(self.comps['eco'], 'out2',
-                                              self.comps['drum'], 'in1')
-            self.conns['dr_eva'] = connection(self.comps['drum'], 'out1',
-                                              self.comps['eva'], 'in2')
-            self.conns['eva_dr'] = connection(self.comps['eva'], 'out2',
-                                              self.comps['drum'], 'in2')
-            self.conns['dr_sup'] = connection(self.comps['drum'], 'out2',
-                                              self.comps['sup'], 'in2')
-            self.conns['sup_eva'] = connection(self.comps['sup'], 'out1',
-                                               self.comps['eva'], 'in1')
-            self.conns['eva_eco'] = connection(self.comps['eva'], 'out1',
-                                               self.comps['eco'], 'in1')
+            self.conns['eco_dr'] = connection(
+                self.comps['eco'], 'out2', self.comps['drum'], 'in1')
+            self.conns['dr_eva'] = connection(
+                self.comps['drum'], 'out1', self.comps['eva'], 'in2')
+            self.conns['eva_dr'] = connection(
+                self.comps['eva'], 'out2', self.comps['drum'], 'in2')
+            self.conns['dr_sup'] = connection(
+                self.comps['drum'], 'out2', self.comps['sup'], 'in2')
+            self.conns['sup_eva'] = connection(
+                self.comps['sup'], 'out1', self.comps['eva'], 'in1')
+            self.conns['eva_eco'] = connection(
+                self.comps['eva'], 'out1', self.comps['eco'], 'in1')
 
 Import your subsystem
 ^^^^^^^^^^^^^^^^^^^^^
@@ -131,16 +132,18 @@ within the same folder as your script.
 
     # %% component parameters
 
-    sg.comps['eco'].set_attr(pr1=0.999,  pr2=0.97, ttd_u=25,
+    sg.comps['eco'].set_attr(pr1=0.999,  pr2=0.97,
                              design=['pr1', 'pr2', 'ttd_u'],
-                             offdesign=['zeta1', 'zeta2', 'kA'])
+                             offdesign=['zeta1', 'zeta2', 'kA_char'])
 
     sg.comps['eva'].set_attr(pr1=0.999, ttd_l=20, design=['pr1', 'ttd_l'],
-                             offdesign=['zeta1', 'kA'])
+                             offdesign=['zeta1', 'kA_char'])
 
     sg.comps['sup'].set_attr(pr1=0.999,  pr2=0.99, ttd_u=50,
                              design=['pr1', 'pr2', 'ttd_u'],
-                             offdesign=['zeta1', 'zeta2', 'kA'])
+                             offdesign=['zeta1', 'zeta2', 'kA_char'])
+
+    sg.conns['eco_dr'].set_attr(Td_bp=-5, design=['Td_bp'])
 
     # %% solve
 

TESPy-0.3.3/docs/whats_new/v0-3-2.rst

@@ -0,0 +1,47 @@
+v0.3.2 - Carnot's Colors (June, 10, 2020)
++++++++++++++++++++++++++++++++++++++++++
+
+New features
+############
+- Colored printouts are available in the :code:`print_results()` method of the
+  network class. There are three different color codes available with default
+  settings:
+
+  - user specified parameters (:code:`'set'`, blue)
+  - component parameters specified as variables (:code:`'var'`, green)
+  - faulty parameters (:code:`'err'`, red)
+
+  In order to change the colors, simply import :code:`coloring` from the
+  :py:mod:`tespy.tools.global_vars` module and adjust the escape codes. For
+  example, to reset all colors to white text:
+
+  .. code-block:: python
+
+        from tespy.tools.global_vars import coloring
+        coloring['set'] = '\033[0m'
+        coloring['err'] = '\033[0m'
+        coloring['var'] = '\033[0m'
+
+  See `here <https://en.wikipedia.org/wiki/ANSI_escape_code#Colors>`_ for a
+  list of available codes
+  (`PR #205 <https://github.com/oemof/tespy/pull/205>`_).
+
+Bug fixes
+#########
+- Readd method for :code:`T_mix_ps` calculation for pure fluids: In case the
+  fluid propagation did not go through (e.g. due to availability of good
+  starting values) the fluid composition at a turbomachine's inlet and outlet
+  may not be equal (`PR #207 <https://github.com/oemof/tespy/pull/207>`_).
+- Fix the calculation of mixture density: The density is calculated as sum of
+  the densities of the mixture components at their respective partial pressure
+  and the mixture temperature
+  (`PR #207 <https://github.com/oemof/tespy/pull/207>`_). With the old method,
+  the specific volume was calculated according to Amagat's law, which produced
+  incorrect values if one or more components of the mixture were liquid at the
+  mixture's temperature and pressure. See discussion about humid air propreties
+  here: `Issue #206 <https://github.com/oemof/tespy/issues/206>`_.
+
+Contributors
+############
+- Francesco Witte (`@fwitte <https://github.com/fwitte>`_)
+- `@jbueck <https://github.com/jbueck>`_

TESPy-0.3.3/docs/whats_new/v0-3-3.rst

@@ -0,0 +1,41 @@
+v0.3.3 - Maxwell’s Memory (July, 21, 2020)
+++++++++++++++++++++++++++++++++++++++++++
+
+New Features
+############
+- In some cases - especially large networks and many simulation runs within a
+  a single script - the fluid property memorisation added a lot of calculation
+  time for searching through the lookup tables of previously calculated fluid
+  property values. It is now possible to manually specify whether or not the
+  fluid property memorisation is performed.
+
+  The memorisation benefits
+
+  - networks using gaseous mixtures and
+  - smaller networks using the HEOS back end.
+
+  The memorisation slows down
+
+  - very large networks and
+  - usage of tabular back ends (BICUBIC or TTSE).
+
+  In order to deactivate memorisation, add
+  :code:`memorise_fluid_properties=False` on network creation, for example:
+
+  .. code-block:: python
+
+      from tespy.networks import network
+
+      mynetwork = network(
+          fluids=['BICUBIC::water'], memorise_fluid_properties=False)
+
+  (`PR #211 <https://github.com/oemof/tespy/pull/211>`_).
+
+Other Changes
+#############
+- Reorder network initialisation process for improved maintenance and faster
+  performance (`PR #204 <https://github.com/oemof/tespy/pull/204>`_).
+
+Contributors
+############
+- Francesco Witte (`@fwitte <https://github.com/fwitte>`_)

{TESPy-0.3.1 → TESPy-0.3.3}/docs/whats_new.rst

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

{TESPy-0.3.1 → TESPy-0.3.3}/setup.py

@@ -25,7 +25,7 @@ def read(*names, **kwargs):
 
 setup(
     name='TESPy',
-    version='0.3.1',
+    version='0.3.3',
     license='MIT',
     description='Thermal Engineering Systems in Python (TESPy)',
     long_description='%s' % (

{TESPy-0.3.1 → TESPy-0.3.3}/src/TESPy.egg-info/PKG-INFO

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

{TESPy-0.3.1 → TESPy-0.3.3}/src/TESPy.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-.bumpversion.cfg
 .coveragerc
 .editorconfig
 .gitignore
@@ -109,6 +108,8 @@ docs/whats_new/v0-2-1.rst
 docs/whats_new/v0-2-2.rst
 docs/whats_new/v0-3-0.rst
 docs/whats_new/v0-3-1.rst
+docs/whats_new/v0-3-2.rst
+docs/whats_new/v0-3-3.rst
 src/TESPy.egg-info/PKG-INFO
 src/TESPy.egg-info/SOURCES.txt
 src/TESPy.egg-info/dependency_links.txt

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8
 
-__version__ = '0.3.1 - Mayer\'s Merit'
+__version__ = '0.3.3 - Maxwell\'s Memory'
 
 # tespy data and connection import
 from . import connections  # noqa: F401

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/components/combustion.py

@@ -1870,7 +1870,7 @@ class combustion_chamber_stoich(combustion_chamber):
         air = self.air_alias.val
         flue_gas = self.fuel_alias.val + '_fg'
 
-        for c in nw.comps.loc[self, 'outlets']:
+        for c in self.outl:
             if not c.fluid.val_set[air]:
                 c.fluid.val[air] = 0.8
             if not c.fluid.val_set[flue_gas]:
@@ -1895,7 +1895,7 @@ class combustion_chamber_stoich(combustion_chamber):
         flue_gas = self.fuel_alias.val + '_fg'
         fuel = self.fuel_alias.val
 
-        for c in nw.comps.loc[self, 'outlets']:
+        for c in self.outl:
             if not c.fluid.val_set[air]:
                 if c.fluid.val[air] > 0.95:
                     c.fluid.val[air] = 0.95
@@ -1914,11 +1914,11 @@ class combustion_chamber_stoich(combustion_chamber):
 
             nw.init_target(c, c.target)
 
-        for i in nw.comps.loc[self, 'inlets']:
+        for i in self.inl:
             if i.m.val_SI < 0 and not i.m.val_set:
                 i.m.val_SI = 0.01
 
-        for c in nw.comps.loc[self, 'outlets']:
+        for c in self.outl:
             if c.m.val_SI < 0 and not c.m.val_set:
                 c.m.val_SI = 10
             nw.init_target(c, c.target)
@@ -2160,21 +2160,21 @@ class combustion_engine(combustion_chamber):
     >>> mode = 'design'
     >>> nw.solve(mode=mode)
     >>> nw.save('tmp')
-    >>> round(chp.ti.val)
+    >>> round(chp.ti.val, 0)
     25300000.0
-    >>> round(chp.Q1.val)
+    >>> round(chp.Q1.val, 0)
     4980000.0
     >>> chp.set_attr(Q1=4e6, P=np.nan)
     >>> mode = 'offdesign'
     >>> nw.solve(mode=mode, init_path='tmp', design_path='tmp')
-    >>> round(chp.ti.val)
+    >>> round(chp.ti.val, 0)
     17794554.0
     >>> round(chp.P.val / chp.P.design, 3)
     0.617
     >>> chp.set_attr(P=chp.P.design * 0.75, Q1=np.nan)
     >>> mode = 'offdesign'
     >>> nw.solve(mode=mode, init_path='tmp', design_path='tmp')
-    >>> round(chp.ti.val)
+    >>> round(chp.ti.val, 0)
     20550000.0
     >>> round(chp.P.val / chp.P.design, 3)
     0.75

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/components/components.py

@@ -27,6 +27,7 @@ from tespy.tools.data_containers import dc_cp
 from tespy.tools.data_containers import dc_gcp
 from tespy.tools.data_containers import dc_simple
 from tespy.tools.fluid_properties import v_mix_ph
+from tespy.tools.global_vars import err
 from tespy.tools.helpers import bus_char_derivative
 from tespy.tools.helpers import bus_char_evaluation
 from tespy.tools.helpers import newton
@@ -563,7 +564,7 @@ class component:
         for p, data in self.variables.items():
             if isinstance(data, dc_cp):
                 val = self.get_attr(p).val
-                if round(val, 6) > data.max_val:
+                if val > data.max_val + err:
                     msg = (
                         'Invalid value for ' + p + ': ' + p + ' = ' +
                         str(val) + ' above maximum value (' +
@@ -571,7 +572,7 @@ class component:
                         '.')
                     logging.warning(msg)
 
-                elif round(val, 6) < data.min_val:
+                elif val < data.min_val - err:
                     msg = (
                         'Invalid value for ' + p + ': ' + p + ' = ' +
                         str(val) + ' below minimum value (' +

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/components/heat_exchangers.py

@@ -319,7 +319,7 @@ class heat_exchanger_simple(component):
                 'in the calculation. If you want to use the value adaption of '
                 'kA by the characteristic line, please use kA_char as '
                 'parameter instead (occurred at ' + self.label + '). This '
-                'warning will disappear in TESPy version 0.3.2.')
+                'warning will disappear in TESPy version 0.4.0.')
             warnings.warn(msg, FutureWarning, stacklevel=2)
 
         self.jacobian = np.zeros((
@@ -1052,9 +1052,9 @@ class parabolic_trough(heat_exchanger_simple):
     >>> inc.set_attr(T=None)
     >>> outg.set_attr(T=350, m=20)
     >>> nw.solve('design')
-    >>> round(inc.T.val)
+    >>> round(inc.T.val, 0)
     229.0
-    >>> round(pt.A.val)
+    >>> round(pt.A.val, 0)
     6862.0
 
     Given this design, it is possible to calculate the outlet temperature as
@@ -1066,9 +1066,9 @@ class parabolic_trough(heat_exchanger_simple):
     >>> inc.set_attr(T=150)
     >>> outg.set_attr(T=None)
     >>> nw.solve('design')
-    >>> round(outg.T.val)
+    >>> round(outg.T.val, 0)
     244.0
-    >>> round(pt.Q.val)
+    >>> round(pt.Q.val, 0)
     3603027.0
     """
 
@@ -1828,7 +1828,7 @@ class heat_exchanger(component):
                 'in the calculation. If you want to use the value adaption of '
                 'kA by the characteristic line, please use kA_char as '
                 'parameter instead (occurred at ' + self.label + '). This '
-                'warning will disappear in TESPy version 0.3.2.')
+                'warning will disappear in TESPy version 0.4.0.')
             warnings.warn(msg, FutureWarning, stacklevel=2)
 
         self.jacobian = np.zeros((
@@ -2705,7 +2705,7 @@ class condenser(heat_exchanger):
                 'in the calculation. If you want to use the value adaption of '
                 'kA by the characteristic line, please use kA_char as '
                 'parameter instead (occurred at ' + self.label + '). This '
-                'warning will disappear in TESPy version 0.3.2.')
+                'warning will disappear in TESPy version 0.4.0.')
             warnings.warn(msg, FutureWarning, stacklevel=2)
 
         self.jacobian = np.zeros((
@@ -3073,7 +3073,7 @@ class desuperheater(heat_exchanger):
                 'in the calculation. If you want to use the value adaption of '
                 'kA by the characteristic line, please use kA_char as '
                 'parameter instead (occurred at ' + self.label + '). This '
-                'warning will disappear in TESPy version 0.3.2.')
+                'warning will disappear in TESPy version 0.4.0.')
             warnings.warn(msg, FutureWarning, stacklevel=2)
 
         self.jacobian = np.zeros((

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/components/turbomachinery.py

@@ -473,7 +473,7 @@ class compressor(turbomachine):
 
             if self.char_warnings is True:
                 msg = ('Created characteristic map for parameter char_map '
-                       ' at component ' + self.label + ' from default data.\n'
+                       'at component ' + self.label + ' from default data.\n'
                        'You can specify your own data using component.char_map'
                        '.set_attr(func=custom_char).\n'
                        'If you want to disable these warnings use '

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/connections.py

@@ -732,7 +732,7 @@ class bus:
     array([0., 3.])
     >>> heat_bus.comps.loc[fgc]['char'].y
     array([-1., -1.])
-    >>> round(chp.ti.val)
+    >>> round(chp.ti.val, 0)
     25813247.0
     >>> round(chp.Q1.val + chp.Q2.val, 0)
     8896898.0
@@ -745,7 +745,7 @@ class bus:
     >>> power_bus.set_attr(P=7.5e6)
     >>> mode = 'offdesign'
     >>> nw.solve(mode=mode, design_path='tmp', init_path='tmp')
-    >>> round(chp.ti.val)
+    >>> round(chp.ti.val, 0)
     21187528.0
     >>> round(chp.P.val / chp.P.design, 3)
     0.761
@@ -902,7 +902,7 @@ class bus:
                         comp = c['c']
                         msg = (
                             'The dictionary keyword "c" will be removed in '
-                            'TESPy version 0.3.2. Please use "comp" instead.')
+                            'TESPy version 0.4.0. Please use "comp" instead.')
                         warnings.warn(msg, FutureWarning, stacklevel=2)
                     else:
                         comp = c['comp']
@@ -924,7 +924,7 @@ class bus:
                         if k == 'p':
                             msg = (
                                 'The dictionary keyword "p" will be removed '
-                                'TESPy version 0.3.2. Please use "param" '
+                                'TESPy version 0.4.0. Please use "param" '
                                 'instead.')
                             warnings.warn(msg, FutureWarning, stacklevel=2)
                         if isinstance(v, str) or v is None:

{TESPy-0.3.1 → TESPy-0.3.3}/src/tespy/networks/network_reader.py

@@ -214,7 +214,7 @@ def load_network(path):
     >>> eta_s_t
     0.898
     >>> igva
-    20.139
+    20.138
 
     The designed network is exported to the path 'exported_nwk'. Now import the
     network and recalculate. Check if the results match with the previous
@@ -305,7 +305,7 @@ def load_network(path):
                     'component data for component of type ' + f[:-4] + '. '
                     'Please make sure to add the column bus_base to your data '
                     'or recreate the network export with the TESPy 0.3.x API. '
-                    'This warning will be removed in TESPy version 0.3.2.')
+                    'This warning will be removed in TESPy version 0.4.0.')
                 warnings.warn(msg, FutureWarning, stacklevel=2)
 
             comps = pd.concat((comps, df[cols]), axis=0)
@@ -395,8 +395,8 @@ def construct_comps(c, *args):
     instance : tespy.components.components.component
         TESPy component object.
     """
-    target_class = comp_target_classes[c.cp]
-    instance = target_class(c.label)
+    target_class = comp_target_classes[c['comp_type']]
+    instance = target_class(c['label'])
     kwargs = {}
 
     # basic properties