tespy 0.0.2__tar.gz → 0.0.3__tar.gz

{TESPy-0.0.2 → TESPy-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 1.0
+Metadata-Version: 1.2
 Name: TESPy
-Version: 0.0.2
+Version: 0.0.3
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: http://github.com/oemof/tespy
 Author: Francesco Witte
@@ -34,7 +34,7 @@ Description: TESPy stands for "Thermal Engineering Systems in Python" and provid
         
           pip install tespy
         
-        If you want to use the latest features, you might want to install the **developer version**. See section `'Developing TESPy' <http://tespy.readthedocs.io/en/latest/developing_oemof.html>`_ for more information. The developer version is not recommended for productive use.
+        If you want to use the latest features, you might want to install the **developer version**. See section `Developing TESPy <http://tespy.readthedocs.io/en/latest/developing_tespy.html>`_ for more information. The developer version is not recommended for productive use.
         
         Examples
         ========
@@ -50,7 +50,8 @@ Description: TESPy stands for "Thermal Engineering Systems in Python" and provid
         
         This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
         
-        You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+        You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
         
         
 Platform: UNKNOWN
+Requires-Python: >=3

{TESPy-0.0.2 → TESPy-0.0.3}/README.rst

@@ -26,7 +26,7 @@ If you have a working Python3 environment, use pypi to install the latest tespy
 
   pip install tespy
 
-If you want to use the latest features, you might want to install the **developer version**. See section `'Developing TESPy' <http://tespy.readthedocs.io/en/latest/developing_oemof.html>`_ for more information. The developer version is not recommended for productive use.
+If you want to use the latest features, you might want to install the **developer version**. See section `Developing TESPy <http://tespy.readthedocs.io/en/latest/developing_tespy.html>`_ for more information. The developer version is not recommended for productive use.
 
 Examples
 ========
@@ -42,5 +42,5 @@ This program is free software: you can redistribute it and/or modify it under th
 
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
 

{TESPy-0.0.2 → TESPy-0.0.3}/TESPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 1.0
+Metadata-Version: 1.2
 Name: TESPy
-Version: 0.0.2
+Version: 0.0.3
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: http://github.com/oemof/tespy
 Author: Francesco Witte
@@ -34,7 +34,7 @@ Description: TESPy stands for "Thermal Engineering Systems in Python" and provid
         
           pip install tespy
         
-        If you want to use the latest features, you might want to install the **developer version**. See section `'Developing TESPy' <http://tespy.readthedocs.io/en/latest/developing_oemof.html>`_ for more information. The developer version is not recommended for productive use.
+        If you want to use the latest features, you might want to install the **developer version**. See section `Developing TESPy <http://tespy.readthedocs.io/en/latest/developing_tespy.html>`_ for more information. The developer version is not recommended for productive use.
         
         Examples
         ========
@@ -50,7 +50,8 @@ Description: TESPy stands for "Thermal Engineering Systems in Python" and provid
         
         This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
         
-        You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+        You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
         
         
 Platform: UNKNOWN
+Requires-Python: >=3

{TESPy-0.0.2 → TESPy-0.0.3}/TESPy.egg-info/SOURCES.txt

@@ -8,8 +8,8 @@ TESPy.egg-info/requires.txt
 TESPy.egg-info/top_level.txt
 tespy/__init__.py
 tespy/connections.py
-tespy/csv_reader.py
 tespy/helpers.py
+tespy/network_reader.py
 tespy/networks.py
 tespy/components/__init__.py
 tespy/components/characteristics.py

TESPy-0.0.3/TESPy.egg-info/requires.txt

@@ -0,0 +1,5 @@
+CoolProp>=6.0.0
+matplotlib>=2.0.2
+numpy>=1.13.3
+pandas>=0.19.2
+scipy>=0.19.1

{TESPy-0.0.2 → TESPy-0.0.3}/setup.cfg

@@ -4,5 +4,4 @@ description-file = README.rst
 [egg_info]
 tag_build = 
 tag_date = 0
-tag_svn_revision = 0
 

{TESPy-0.0.2 → TESPy-0.0.3}/setup.py

@@ -7,7 +7,7 @@ def read(fname):
 
 
 setup(name='TESPy',
-      version='0.0.2',
+      version='0.0.3',
       description='Thermal Engineering Systems in Python (TESPy)',
       url='http://github.com/oemof/tespy',
       author='Francesco Witte',

{TESPy-0.0.2 → TESPy-0.0.3}/tespy/__init__.py

@@ -9,4 +9,4 @@ from tespy.components import (components as cmp,
 from tespy import connections as con
 from tespy import helpers as hlp
 from tespy import networks as nwk
-from tespy import csv_reader as csv_r
+from tespy import network_reader as nwkr

{TESPy-0.0.2 → TESPy-0.0.3}/tespy/components/characteristics.py

@@ -323,7 +323,9 @@ class characteristics:
     **allowed keywords** in kwargs (also see characteristics.attr()):
 
     - x, y (*numeric*) - values for function parameters x and function values y
-    - method (*str*) - method to choose from for default characteristic
+    - method (*str*) - keyword method is necessary, if you do not provide any
+      x or y data. TESPy will use the characteristics as stated in the
+      subclasses
     """
 
     def __init__(self, **kwargs):
@@ -363,6 +365,21 @@ class characteristics:
     def f_x(self, x):
         return self.char(x)
 
+    def get_attr(self, key):
+        """
+        get the value of a characteristics attribute
+
+        :param key: attribute to return its value
+        :type key: str
+        :returns:
+            - :code:`self.__dict__[key]` if object has attribute key
+            - :code:`None` if object has no attribute key
+        """
+        if key in self.__dict__:
+            return self.__dict__[key]
+        else:
+            return None
+
 
 class turbine(characteristics):
     r"""
@@ -375,7 +392,6 @@ class turbine(characteristics):
 
     **literature**
 
-    - EBSILON®Professional -> (EBS_ST, EBS_GT)
     - Walter Traupel (2001): Thermische Turbomaschinen Band 2. Berlin: Spinger.
       -> TRAUPEL
     """
@@ -383,14 +399,14 @@ class turbine(characteristics):
     def default(self, key):
         r"""
 
-        default characteristic lines for turbines, designed for the following
-        cases:
+        default **characteristic lines** for turbines **are designed for the
+        following cases**:
 
             \frac{\eta_\mathrm{s,t}}{\eta_\mathrm{s,t,ref}}=f\left(X \right)
 
         available lines characteristics:
 
-        **EBS_ST**
+        **GENERIC**
 
         .. math::
 
@@ -405,19 +421,22 @@ class turbine(characteristics):
             \text{pressure ratio}
             \end{cases}
 
-        **EBS_GT**
-
-        .. math::
-
-            X=f\left(
-            \frac{\dot{m}}{\dot{m}_{ref}} \right)
+        .. image:: _images/GENERIC.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
 
         **TRAUPEL**
 
         .. math::
 
-           X=f\left(\frac{
-            \sqrt{\Delta h_\mathrm{s,ref}}}{\sqrt{\Delta h_\mathrm{s}}} \right)
+           X=\frac{
+            \sqrt{\Delta h_\mathrm{s,ref}}}{\sqrt{\Delta h_\mathrm{s}}}
+
+        .. image:: _images/TRAUPEL.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
         """
 
         if key == 'default':
@@ -426,14 +445,8 @@ class turbine(characteristics):
         x = {}
         y = {}
 
-        x['EBS_ST'] = np.array([0, 0.5, 0.6, 0.7, 0.8,
-                                0.9, 0.95, 1, 1.05, 1.1])
-        y['EBS_ST'] = np.array([0.98, 0.991, 0.993, 0.995, 0.9975,
-                                0.999, 0.9998, 1, 0.9995, 0.995])
-
-        x['EBS_GT'] = np.array([0, 0.4, 0.7, 1, 1.2])
-        y['EBS_GT'] = np.array([0.85, 0.9, 0.95, 1, 1.1])
-
+        x['GENERIC'] = np.array([0, 0.5, 0.8, 0.95, 1, 1.05, 1.2])
+        y['GENERIC'] = np.array([0.975, 0.985, 0.994, 0.999, 1, 0.999, 0.99])
         x['TRAUPEL'] = np.array([0.0, 0.1905, 0.3810, 0.5714, 0.7619, 0.9524,
                                  1.0, 1.1429, 1.3333, 1.5238, 1.7143, 1.9048])
         y['TRAUPEL'] = np.array([0.0, 0.3975, 0.6772, 0.8581, 0.9593, 0.9985,
@@ -450,17 +463,13 @@ class heat_ex(characteristics):
     - links heat transfer coefficient :math:`kA` to keyfigures
     - different default characteristic lines available for different types of
       heat exchangers (see method heat_exchanger.default())
-
-    **literature**
-
-    - EBSILON®Professional
     """
 
     def default(self, key):
         r"""
 
-        default characteristic lines for heat exchangers, designed for the
-        following cases
+        default **characteristic lines** for heat exchangers **are designed for
+        the following cases**:
 
         .. math::
 
@@ -471,9 +480,41 @@ class heat_ex(characteristics):
 
         **condensing fluid** (COND)
 
+        .. image:: _images/COND_HOT.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
+        .. image:: _images/COND_COLD.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
         **economiser, evaporator, superheater** (EVA)
 
+        .. image:: _images/EVA_HOT.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
+        .. image:: _images/EVA_COLD.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
+
         **heat exchanger without phase change** (HE)
+
+        .. image:: _images/HE_HOT.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
+        .. image:: _images/HE_COLD.svg
+           :scale: 100 %
+           :alt: alternative text
+           :align: center
+
         """
 
         if key == 'default':
@@ -486,67 +527,49 @@ class heat_ex(characteristics):
                                   0.4, 0.45, 0.5, 0.55, 0.6, 0.65, 0.7, 0.75,
                                   0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
         y['COND_HOT'] = np.array(
-                [0.02973, 0.158224976, 0.344331588, 0.566735359, 0.837603879,
-                 0.887682367, 0.906155915, 0.920848007, 0.932926712,
-                 0.943098753, 0.951818579, 0.959395358, 0.966050399,
-                 0.971948814, 0.977216972, 0.981954722, 0.986241309,
-                 0.990140862, 0.993705593, 0.996980089, 1,
-                 1.021079344, 1.033356087])
+                [0.030, 0.158, 0.344, 0.567, 0.838, 0.888, 0.906, 0.921, 0.933,
+                 0.943, 0.952, 0.959, 0.966, 0.972, 0.977, 0.982, 0.986, 0.990,
+                 0.994, 0.997, 1.000, 1.021, 1.033])
 
         x['COND_COLD'] = np.array([0.01, 0.04, 0.07, 0.11, 0.15, 0.2, 0.25,
                                    0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.65,
                                    0.7, 0.75, 0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
         y['COND_COLD'] = np.array(
-                [0.018463261, 0.075067197, 0.133570112, 0.191619581,
-                 0.243225424, 0.303098102, 0.359180259, 0.412325796,
-                 0.463079045, 0.51181624, 0.558812429, 0.60427717,
-                 0.648375355, 0.691240341, 0.732981162, 0.773690063,
-                 0.813445241, 0.852314326, 0.890355383, 0.927620578,
-                 0.96415523, 1, 1.32719114, 1.611507617])
+                [0.019, 0.075, 0.134, 0.192, 0.243, 0.303, 0.359, 0.412, 0.463,
+                 0.512, 0.559, 0.604, 0.648, 0.691, 0.733, 0.774, 0.813, 0.852,
+                 0.890, 0.928, 0.964, 1.000, 1.327, 1.612])
 
         x['EVA_HOT'] = np.array([0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35,
                                  0.4, 0.45, 0.5, 0.55, 0.6, 0.65, 0.7, 0.75,
                                  0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
         y['EVA_HOT'] = np.array(
-                [0.02973, 0.158224976, 0.245102611, 0.313341319,
-                 0.373026946, 0.427137157, 0.47724348, 0.524292071,
-                 0.568899886, 0.611492524, 0.652376002, 0.691778225,
-                 0.729874262, 0.766801896, 0.802672745, 0.837578965,
-                 0.871597681, 0.904795341, 0.937229127, 0.968949206,
-                 1, 1.280887381, 1.522736893])
+                [0.030, 0.158, 0.245, 0.313, 0.373, 0.427, 0.477, 0.524, 0.569,
+                 0.611, 0.652, 0.692, 0.730, 0.767, 0.803, 0.838, 0.872, 0.905,
+                 0.937, 0.969, 1.000, 1.281, 1.523])
 
         x['EVA_COLD'] = np.array([0.01, 0.04, 0.07, 0.11, 0.15, 0.2, 0.25,
                                   0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.65,
-                                  0.7, 0.75, 0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
+                                  0.7, 0.8, 1, 2])
         y['EVA_COLD'] = np.array(
-                [0.018463261, 0.075067197, 0.133570112, 0.21471286,
-                 0.299696637, 0.411795286, 0.531045125, 0.658214945,
-                 0.79419022, 0.93999639, 0.98834217, 0.991335466,
-                 0.993588025, 0.995293228, 0.996578973, 0.997548422,
-                 0.998278986, 0.99883052, 0.999248543, 0.99956641,
-                 0.99981029, 1, 1.000821953, 1.001399035])
+                [0.018, 0.075, 0.134, 0.215, 0.300, 0.412, 0.531, 0.658, 0.794,
+                 0.934, 0.988, 0.991, 0.994, 0.995, 0.997, 0.998, 0.999, 1.000,
+                 1.001])
 
         x['HE_HOT'] = np.array([0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35,
                                 0.4, 0.45, 0.5, 0.55, 0.6, 0.65, 0.7, 0.75,
                                 0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
         y['HE_HOT'] = np.array(
-                [0.02973, 0.158224976, 0.344331588, 0.468764994,
-                 0.534754865, 0.589981027, 0.637684499, 0.679796476,
-                 0.717557145, 0.751806751, 0.783141431, 0.812002348,
-                 0.838728656, 0.863589075, 0.886802791, 0.908551927,
-                 0.928989721, 0.948247667, 0.966438652, 0.983660777,
-                 1, 1.127936069, 1.215724268])
+                [0.030, 0.158, 0.344, 0.469, 0.535, 0.590, 0.638, 0.680, 0.718,
+                 0.752, 0.783, 0.812, 0.839, 0.864, 0.887, 0.909, 0.929, 0.948,
+                 0.966, 0.984, 1.000, 1.128, 1.216])
 
         x['HE_COLD'] = np.array([0.01, 0.04, 0.07, 0.11, 0.15, 0.2, 0.25,
                                  0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.65,
                                  0.7, 0.75, 0.8, 0.85, 0.9, 0.95, 1, 1.5, 2])
         y['HE_COLD'] = np.array(
-                [0.018463261, 0.075067197, 0.133570112, 0.21471286,
-                 0.299696637, 0.411795286, 0.507493865, 0.563726047,
-                 0.614056785, 0.659538874, 0.700953194, 0.738902236,
-                 0.773858327, 0.806203578, 0.836251881, 0.864264923,
-                 0.890463551, 0.915036349, 0.938144588, 0.959929163,
-                 0.980511906, 1, 1.151082849, 1.25295985])
+                [0.018, 0.075, 0.134, 0.215, 0.300, 0.412, 0.507, 0.564, 0.614,
+                 0.660, 0.701, 0.739, 0.774, 0.806, 0.836, 0.864, 0.890, 0.915,
+                 0.938, 0.960, 0.981, 1.000, 1.151, 1.253])
 
         return x[key], y[key]