tespy 0.3.1__tar.gz → 0.3.2__tar.gz

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

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: TESPy
-Version: 0.3.1
+Version: 0.3.2
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: https://github.com/oemof/tespy
 Author: Francesco Witte
 Author-email: francesco.witte@hs-flensburg.de
 License: MIT
+Project-URL: Issue Tracker, https://github.com/oemof/tespy/issues
 Project-URL: Documentation, https://tespy.readthedocs.io/
 Project-URL: Changelog, https://tespy.readthedocs.io/en/latest/whats_new.html
-Project-URL: Issue Tracker, https://github.com/oemof/tespy/issues
 Description: Thermal Engineering Systems in Python
         =====================================
         
@@ -139,5 +139,5 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.6, <3.9
-Provides-Extra: dev
 Provides-Extra: dummy
+Provides-Extra: dev

TESPy-0.3.2/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.1 → TESPy-0.3.2}/docs/whats_new.rst

@@ -7,7 +7,8 @@ Discover noteable new features and improvements in each release
     :depth: 1
     :local:
     :backlinks: top
-
+    
+.. 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.2}/setup.py

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

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

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: TESPy
-Version: 0.3.1
+Version: 0.3.2
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: https://github.com/oemof/tespy
 Author: Francesco Witte
 Author-email: francesco.witte@hs-flensburg.de
 License: MIT
+Project-URL: Issue Tracker, https://github.com/oemof/tespy/issues
 Project-URL: Documentation, https://tespy.readthedocs.io/
 Project-URL: Changelog, https://tespy.readthedocs.io/en/latest/whats_new.html
-Project-URL: Issue Tracker, https://github.com/oemof/tespy/issues
 Description: Thermal Engineering Systems in Python
         =====================================
         
@@ -139,5 +139,5 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.6, <3.9
-Provides-Extra: dev
 Provides-Extra: dummy
+Provides-Extra: dev

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

@@ -109,6 +109,7 @@ 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
 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.2}/src/tespy/__init__.py

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

{TESPy-0.3.1 → TESPy-0.3.2}/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((
@@ -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.2}/src/tespy/connections.py

@@ -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.2}/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)

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

@@ -42,6 +42,7 @@ from tespy.components.reactors import water_electrolyzer
 from tespy.tools import data_containers as dc
 from tespy.tools import fluid_properties as fp
 from tespy.tools import helpers as hlp
+from tespy.tools.global_vars import coloring
 from tespy.tools.global_vars import err
 
 
@@ -2542,13 +2543,18 @@ class network:
             if c.printout is True:
                 row = (c.source.label + ':' + c.source_id + ' -> ' +
                        c.target.label + ':' + c.target_id)
-                df.loc[row] = (
-                        [c.m.val_SI / self.m[self.m_unit],
-                         c.p.val_SI / self.p[self.p_unit],
-                         c.h.val_SI / self.h[self.h_unit],
-                         c.T.val_SI / self.T[self.T_unit][1] -
-                         self.T[self.T_unit][0]]
-                        )
+
+                row_data = []
+                for var in ['m', 'p', 'h', 'T']:
+                    if c.get_attr(var).val_set is True:
+                        row_data += [
+                            coloring['set'] + str(c.get_attr(var).val) +
+                            coloring['end']
+                        ]
+                    else:
+                        row_data += [str(c.get_attr(var).val)]
+
+                df.loc[row] = row_data
         if len(df) > 0:
             print('##### RESULTS (connections) #####')
             print(
@@ -2580,7 +2586,15 @@ class network:
 
     def print_components(c, *args):
         if c.name.printout is True:
-            return c.name.get_attr(args[0]).val
+            val = float(c.name.get_attr(args[0]).val)
+            if (val < c.name.get_attr(args[0]).min_val or
+                    val > c.name.get_attr(args[0]).max_val):
+                return coloring['err'] + ' ' + str(val) + ' ' + coloring['end']
+            if c.name.get_attr(args[0]).is_var:
+                return coloring['var'] + ' ' + str(val) + ' ' + coloring['end']
+            if c.name.get_attr(args[0]).is_set:
+                return coloring['set'] + ' ' + str(val) + ' ' + coloring['end']
+            return str(val)
         else:
             return np.nan
 

{TESPy-0.3.1 → TESPy-0.3.2}/src/tespy/tools/fluid_properties.py

@@ -114,19 +114,16 @@ class tespy_fluid:
     0.0
 
     >>> v_tespy = v_mix_pT(fluid_props, T2)
-    >>> fluid_props_CP = [0, p, 0, {'air': 1}]
     >>> v = v_mix_pT(fluid_props_CP, T2)
     >>> round(abs(v_tespy - v) / v, 2)
     0.0
 
     >>> s_tespy = s_mix_pT(fluid_props, T2) - s_mix_pT(fluid_props, T1)
-    >>> fluid_props_CP = [0, p, 0, {'air': 1}]
     >>> s = s_mix_pT(fluid_props_CP, T2) - s_mix_pT(fluid_props_CP, T1)
     >>> round(abs(s_tespy - s) / s, 2)
     0.0
 
     >>> visc_tespy = visc_mix_pT(fluid_props, T2)
-    >>> fluid_props_CP = [0, p, 0, {'air': 1}]
     >>> visc = visc_mix_pT(fluid_props_CP, T2)
     >>> round(abs(visc_tespy - visc) / visc, 2)
     0.0
@@ -767,67 +764,46 @@ def T_mix_ps(flow, s, T0=300):
 
         val = newton(s_mix_pT, ds_mix_pdT, flow, s, val0=T0,
                      valmin=valmin, valmax=3000, imax=10)
-        if memorisation is True:
-            new = np.asarray(
-                [[flow[1], flow[2]] + list(flow[3].values()) + [s, val]])
-            # memorise the newly calculated value
-            memorise.T_ps[fl] = np.append(memorise.T_ps[fl], new, axis=0)
 
-        return val
     else:
         # calculate fluid property for pure fluids
-        msg = ('The calculation of temperature from pressure and entropy '
-               'for pure fluids should not be required, as the '
-               'calculation is always possible from pressure and '
-               'enthalpy. If there is a case, where you need to calculate '
-               'temperature from these properties, please inform us: '
-               'https://github.com/oemof/tespy.')
-        logging.error(msg)
-        raise ValueError(msg)
+        val = T_ps(flow[1], s, fluid)
+
+    if memorisation is True:
+        new = np.asarray(
+            [[flow[1], flow[2]] + list(flow[3].values()) + [s, val]])
+        # memorise the newly calculated value
+        memorise.T_ps[fl] = np.append(memorise.T_ps[fl], new, axis=0)
+
+    return val
+
+
+def T_ps(p, s, fluid):
+    r"""
+    Calculate the temperature from pressure and entropy for a pure fluid.
+
+    Parameters
+    ----------
+    p : float
+       Pressure p / Pa.
 
-# %% deprecated
-#            for fluid, x in flow[3].items():
-#                if x > err:
-#                    val = T_ps(flow[1], s, fluid)
-#                    new = np.array([[flow[1], flow[2]] +
-#                                   list(flow[3].values()) + [s, val]])
-#                    # memorise the newly calculated value
-#                    memorise.T_ps[fl] = np.append(memorise.T_ps[fl],
-#                                                  new, axis=0)
-#                    return val
-#
-#
-# def T_ps(p, s, fluid):
-#     r"""
-#     Calculate the temperature from pressure and entropy for a pure fluid.
-#
-#     Parameters
-#     ----------
-#     p : float
-#        Pressure p / Pa.
-#
-#     s : float
-#        Specific entropy h / (J/(kgK)).
-#
-#     fluid : str
-#        Fluid name.
-#
-#     Returns
-#     -------
-#     T : float
-#        Temperature T / K.
-#     """
-#     if 'IDGAS::' in fluid:
-#         msg = 'Ideal gas calculation not available by now.'
-#         logging.warning(msg)
-#     if 'TESPy::' in fluid:
-#         db = tespy_fluid.fluids[fluid].funcs['s_pT']
-#         return newton(reverse_2d, reverse_2d_deriv, [db, p, s], 0)
-#     elif 'INCOMP::' in fluid:
-#         return CPPSI('T', 'P', p, 'H', s, fluid)
-#     else:
-#         memorise.state[fluid].update(CP.PSmass_INPUTS, p, s)
-#         return memorise.state[fluid].T()
+    s : float
+       Specific entropy h / (J/(kgK)).
+
+    fluid : str
+       Fluid name.
+
+    Returns
+    -------
+    T : float
+       Temperature T / K.
+    """
+    if fluid in tespy_fluid.fluids.keys():
+        db = tespy_fluid.fluids[fluid].funcs['s_pT']
+        return newton(reverse_2d, reverse_2d_deriv, [db, p, s], 0)
+    else:
+        memorise.state[fluid].update(CP.PSmass_INPUTS, p, s)
+        return memorise.state[fluid].T()
 
 # %%
 
@@ -1327,14 +1303,19 @@ def v_mix_pT(flow, T):
 
     .. math::
 
-        v_{mix}(p,T)=\sum_{i} \frac{x_i}{\rho(p, T, fluid_{i})}
+        v_{mix}(p,T)=\frac{1}{\sum_{i} \rho(pp_{i}, T, fluid_{i})}\;
+        \forall i \in \text{fluid components}\\
+        pp: \text{partial pressure}
     """
-    v = 0
+    n = molar_mass_flow(flow[3])
+
+    d = 0
     for fluid, x in flow[3].items():
         if x > err:
-            v += x / d_pT(flow[1], T, fluid)
+            ni = x / molar_masses[fluid]
+            d += d_pT(flow[1] * ni / n, T, fluid)
 
-    return v
+    return 1 / d
 
 
 def d_mix_pT(flow, T):

{TESPy-0.3.1 → TESPy-0.3.2}/src/tespy/tools/global_vars.py

@@ -13,3 +13,10 @@ err = 1e-6
 molar_masses = {}
 gas_constants = {}
 gas_constants['uni'] = 8.3144598
+# Define colors for highlighting values in result table
+coloring = {
+    'end': '\033[0m',
+    'set': '\033[94m',
+    'err': '\033[31m',
+    'var': '\033[32m'
+}

{TESPy-0.3.1 → TESPy-0.3.2}/tests/test_errors.py

@@ -32,7 +32,6 @@ from tespy.tools.characteristics import load_custom_char
 from tespy.tools.data_containers import data_container
 from tespy.tools.data_containers import dc_cc
 from tespy.tools.data_containers import dc_flu
-from tespy.tools.fluid_properties import T_mix_ps
 from tespy.tools.fluid_properties import h_mix_pQ
 from tespy.tools.fluid_properties import memorise
 from tespy.tools.fluid_properties import tespy_fluid
@@ -720,8 +719,3 @@ def test_IF97_back_end():
 def test_h_mix_pQ_on_mixtures():
     with raises(ValueError):
         h_mix_pQ([0, 0, 0, {'O2': 0.24, 'N2': 0.76}], 0.75)
-
-
-def test_T_mix_ps_on_pure_fluids():
-    with raises(ValueError):
-        T_mix_ps([0, 0, 0, {'O2': 1}], 1e3)

{TESPy-0.3.1 → TESPy-0.3.2}/tests/test_tools/test_fluid_properties.py

@@ -168,9 +168,11 @@ def test_tespy_fluid_mixture():
     pmin = 1e4
     pmax = 1e7
 
+    # As the tespy fluid is part of a mixture, the minimum pressure for lookup
+    # table creation must be much lower than the actual pressure range tested.
     fp.tespy_fluid(
         alias='partial', fluid=partial_mix,
-        p_range=[pmin, pmax], T_range=[Tmin, Tmax])
+        p_range=[pmin / 3, pmax], T_range=[Tmin, Tmax])
 
     flow_mix = [0, 0, 0, mixture]
     flow_full = [0, 0, 0, full_mix]