exerpy 0.0.1__py3-none-any.whl

exerpy/parser/from_ebsilon/utils.py

@@ -0,0 +1,79 @@
+import functools
+from typing import Any
+from typing import Callable
+from typing import TypeVar
+from typing import cast
+
+from exerpy.parser.from_ebsilon import __ebsilon_available__
+
+# Type variable for the decorated function
+F = TypeVar('F', bound=Callable[..., Any])
+
+def require_ebsilon(func: F) -> F:
+    """
+    Decorator to ensure that Ebsilon functionality is available.
+    
+    Args:
+        func: The function that requires Ebsilon functionality
+        
+    Returns:
+        The wrapped function that checks for Ebsilon availability
+        
+    Raises:
+        RuntimeError: If Ebsilon functionality is not available
+    """
+    @functools.wraps(func)
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        if not __ebsilon_available__:
+            error_msg = (
+                "Ebsilon functionality is not available because the 'EBS' "
+                "environment variable is not set or EbsOpen could not be imported. "
+                "Please set the EBS environment variable to your Ebsilon installation path."
+            )
+            raise RuntimeError(error_msg)
+        return func(*args, **kwargs)
+    
+    return cast(F, wrapper)
+
+
+# Stub classes for when Ebsilon isn't available
+class EpSubstanceStub:
+    """Stub class for EpSubstance when Ebsilon is not available."""
+    epSubstanceN2 = 0
+    epSubstanceO2 = 1
+    epSubstanceCO2 = 2
+    epSubstanceH2O = 3
+    epSubstanceAR = 4
+    # Add other substance constants as needed with placeholder values
+    
+    @staticmethod
+    def get_substance_name(substance_id: int) -> str:
+        """Return placeholder substance name for the given ID."""
+        return f"Substance_{substance_id}"
+
+
+class EpFluidTypeStub:
+    """Stub class for EpFluidType when Ebsilon is not available."""
+    epFluidTypeNONE = 0
+    epFluidTypeAir = 1
+    epFluidTypeFluegas = 2
+    epFluidTypeSteam = 3
+    epFluidTypeWater = 4
+    # Add other fluid type constants as needed
+
+
+class EpSteamTableStub:
+    """Stub class for EpSteamTable when Ebsilon is not available."""
+    epSteamTableFromSuperiorModel = 0
+
+
+class EpGasTableStub:
+    """Stub class for EpGasTable when Ebsilon is not available."""
+    epGasTableFromSuperiorModel = 0
+
+
+class EpCalculationResultStatus2Stub:
+    """Stub class for EpCalculationResultStatus2 when Ebsilon is not available."""
+    epCalculationResultStatus2OK = 0
+    epCalculationResultStatus2Warning = 1
+    epCalculationResultStatus2Error = 2

exerpy/parser/from_tespy/tespy_config.py

@@ -0,0 +1,23 @@
+EXERPY_TESPY_MAPPINGS = {
+    "SteamTurbine": "Turbine",
+    "HeatExchanger": "HeatExchanger",
+    "MovingBoundaryHeatExchanger": "HeatExchanger",
+    "Desuperheater": "HeatExchanger",
+    "MovingBoundaryHeatExchanger": "HeatExchanger",
+    "Condenser": "Condenser",
+    "SimpleHeatExchanger": "SimpleHeatExchanger",
+    "ParabolicTrough": "SimpleHeatExchanger",
+    "Pipe": "SimpleHeatExchanger",
+    "SolarCollector": "SimpleHeatExchanger",
+    "CombustionChamber": "CombustionChamber",
+    "DiabaticCombustionChamber": "CombustionChamber",
+    "Valve": "Valve",
+    "Compressor": "Compressor",
+    "Pump": "Pump",
+    "Turbine": "Turbine",
+    "Merge": "Mixer",
+    "Generator": "Generator",
+    "Motor": "Motor",
+    "Drum": "Drum",
+    "CycleCloser": "CycleCloser",
+}

exerpy-0.0.1.dist-info/METADATA

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: exerpy
+Version: 0.0.1
+Summary: Exergy analysis for tabular input data
+Author-email: Sergio Tomasinelli <s.tomasinelli@tu-berlin.de>, Robert Müller <robert.mueller.2@tu-berlin.de>, Francesco Witte <github@witte.sh>
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: pywin32 ; extra == "aspen"
+Requires-Dist: build ; extra == "dev"
+Requires-Dist: flit ; extra == "dev"
+Requires-Dist: furo ; extra == "dev"
+Requires-Dist: isort ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: sphinx>=7.2.2 ; extra == "dev"
+Requires-Dist: sphinx-copybutton ; extra == "dev"
+Requires-Dist: sphinx-design ; extra == "dev"
+Requires-Dist: sphinxcontrib.bibtex ; extra == "dev"
+Requires-Dist: tespy ; extra == "dev"
+Requires-Dist: tox ; extra == "dev"
+Requires-Dist: pywin32 ; extra == "ebsilon"
+Requires-Dist: tespy ; extra == "tespy"
+Project-URL: Changelog, https://exerpy.readthedocs.io/en/latest/whats_new.html
+Project-URL: Documentation, https://exerpy.readthedocs.io/
+Project-URL: Homepage, https://github.com/oemof/exerpy
+Project-URL: Issue Tracker, https://github.com/oemof/exerpy/issues
+Provides-Extra: aspen
+Provides-Extra: dev
+Provides-Extra: ebsilon
+Provides-Extra: tespy
+
+#################################
+ExerPy: Exergy Analysis in Python
+#################################
+
+ExerPy is a Python library designed to perform detailed exergy analysis of
+energy conversion systems. It builds on the exergy analysis methodology
+implemented in TESPy, while extending its capabilities to seamlessly integrate
+with simulation tools such as Ebsilon Professional, Aspen Plus, and TESPy itself.
+ExerPy enables engineers and researchers to identify inefficiencies and optimize
+the performance of thermodynamic systems through automated workflows and
+consistent data handling.
+
+With its advanced features, ExerPy calculates both physical and chemical exergy,
+allowing users to analyze both individual components and entire systems. This
+helps to identify where and why exergy losses occur, facilitating strategies to improve
+efficiency, reduce costs, and support sustainable energy usage.
+
+.. figure:: https://raw.githubusercontent.com/oemof/exerpy/refs/heads/main/docs/_static/images/logo_exerpy_big.svg
+    :align: center
+
+************
+Key Features
+************
+
+- **Comprehensive Exergy Analysis**: Calculate physical and chemical exergy, perform component-level and system-wide analysis.
+- **Flexible Integration**: Compatible with multiple simulation tools (Ebsilon Professional, Aspen Plus, TESPy).
+- **Advanced Component Library**: Pre-built components for common energy system elements (turbines, heat exchangers, etc.).
+- **Extensible Architecture**: Easy-to-use framework for implementing custom components and analysis methods.
+- **Robust Data Handling**: Consistent fluid property models and automated data extraction from simulation tools.
+- **Open Source**: MIT licensed, free for academic and commercial use.
+
+***************
+Getting Started
+***************
+
+============
+Installation
+============
+You can install the latest version of ExerPy using pip:
+
+.. code:: bash
+
+    pip install exerpy
+
+===================
+Quick Start Example
+===================
+Here's a simple example how to perform an exergy analysis using ExerPy:
+
+.. code:: python
+
+    from exerpy import ExergyAnalysis
+
+    model_path = 'my_model.ebs'
+
+    ean = ExergyAnalysis.from_ebsilon(model_path, chemExLib='Ahrendts')
+
+    fuel = {"inputs": ['Fuel'], "outputs": []}
+    product = {"inputs": ['Power'], "outputs": []}
+
+    ean.analyse(E_F=fuel, E_P=product)
+    ean.exergy_results()
+
+For more detailed tutorials and examples, see the
+`online documentation <https://exerpy.readthedocs.io>`__.
+
+********
+Citation
+********
+
+If you use ExerPy in your scientific work, please consider citing it to support
+ongoing development. You can cite ExerPy using the following BibTeX entry:
+
+.. code::
+
+    @software{ExerPy,
+         author = {Tomasinelli, Sergio and Witte, Francesco and Müller, Robert},
+         title = {{ExerPy}: Exergy Analysis in Python},
+         note = {Supervision: Prof. Dr.-Ing. Fontina Petrakopoulou}
+         url = {https://github.com/oemof/exerpy},
+         version = {0.0.1},
+         year = {2025}
+    }
+
+*******
+License
+*******
+
+MIT License
+
+Copyright (c) Sergio Tomasinelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

exerpy-0.0.1.dist-info/RECORD

@@ -0,0 +1,44 @@
+exerpy/__init__.py,sha256=a8a1TdAkXtgHwFSPnW5oSthAPUDWfscgMhXjhKGs3KM,280
+exerpy/analyses.py,sha256=IXAtiJhVutig1PXIzPaxtL8BzetM4oDTmsvwYBQ_XA0,79098
+exerpy/functions.py,sha256=STNgo7YyT0pZWSVOO0iJb_7Wh9qecNaujJF2eC6Jv7E,30142
+exerpy/components/__init__.py,sha256=KbYJVGaQMlV1KqmQNOYLHa9cN1V9RicclwHPL3VieXU,709
+exerpy/components/component.py,sha256=oWaE8WZ5t_RWlRjtPmgfzAxMO5UVDC3SlX9JPjBQ9hI,3899
+exerpy/components/combustion/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/combustion/base.py,sha256=oCI7pdSdU6rgHayHuHhgHM2gkjib3RmOTk3mORf0edY,10497
+exerpy/components/heat_exchanger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/heat_exchanger/base.py,sha256=GDHKH22kLwdiDCDyvHz73uNIsXuBCEuAqyFetRghINw,23563
+exerpy/components/heat_exchanger/condenser.py,sha256=QW2eULJEHNPcSsIcOow5NUZxxCZioIelSb4-pngIYn4,15365
+exerpy/components/heat_exchanger/simple.py,sha256=0cvikDqES6WsM5Yp2AqnypnoC46Ld2LINTx4uadWnhc,16047
+exerpy/components/heat_exchanger/steam_generator.py,sha256=dvA4kAJEANEt4GFvd8e7CEZCuGIrB87N6-11j0VZvxs,11336
+exerpy/components/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/helpers/cycle_closer.py,sha256=FY4K-HzNIfd3HiiPluoFDFcv-HD1rNdXdqfVZZ0cnzE,3898
+exerpy/components/nodes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/nodes/deaerator.py,sha256=vJiwV2gayeRx5LSXfGXaDsueItfJPrXLppQTZN1UsqQ,13392
+exerpy/components/nodes/drum.py,sha256=VQHWDPICVI7zlqSO0n7V8dHGOTycZGs-5FVZASIPwFQ,7557
+exerpy/components/nodes/flash_tank.py,sha256=y1e5hp8w_HcAo5IX_nsPleRcU0OcnRd55mScXUhtdR0,3582
+exerpy/components/nodes/mixer.py,sha256=bijow9KF-7vHdSchkCaX3SnabwGqWmzkM756Fg8I-mU,14115
+exerpy/components/piping/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/piping/valve.py,sha256=SiBqVcWxV6WqGMICbXNPsC4mfpY4-zoFX06nMg7Ka_M,17006
+exerpy/components/power_machines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/power_machines/generator.py,sha256=fmCs0jzsPqG26fvR1N9DV38T-032RwEIgnXAj1rXmVg,6227
+exerpy/components/power_machines/motor.py,sha256=_K73bN0tjD6kz1fvUU9rWI8yAHsQqI9GHwyRYCDGWHg,6306
+exerpy/components/turbomachinery/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/components/turbomachinery/compressor.py,sha256=HmQdUaYN3rxoq7-GxqomCHWCHnthS7We748I0wMkcPs,14074
+exerpy/components/turbomachinery/pump.py,sha256=t5ZrolL0gU5K6uTeQFrSqmM9qahCSR-h7W1lfnIrK6w,13469
+exerpy/components/turbomachinery/turbine.py,sha256=K7NThlNAvKSjvFl_RVMlOuYdzd0uiVaX7ErVrNYoNvE,15667
+exerpy/data/Ahrendts.json,sha256=Wy7iSBW2u9V_RSjI9nAAfqC9aMo2owNKnyf5ZRLxa0c,9263
+exerpy/parser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/parser/from_aspen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exerpy/parser/from_aspen/aspen_config.py,sha256=GkRJ7AZlglalPWXlbjM5eICLRG8CQuXOhF88zYzNAWM,1749
+exerpy/parser/from_aspen/aspen_parser.py,sha256=QOrVIFeLBX8yvsoKUugDRjCYSxht2dKcpkSsZqXqLRc,38811
+exerpy/parser/from_ebsilon/__init__.py,sha256=rzTkkko93YomWo0EYDnaPP5f7wITorcr5pztPwu54AI,1086
+exerpy/parser/from_ebsilon/check_ebs_path.py,sha256=Ad49eggah8LQkn1hQrHjC_MAgeXkAlVd-YPrC2lpOpo,2618
+exerpy/parser/from_ebsilon/ebsilon_config.py,sha256=7VPvPQrG6OBRI7cTKRSVDDr7-GZ6zKtmFRHcRxXOqvs,39520
+exerpy/parser/from_ebsilon/ebsilon_functions.py,sha256=mY25RPnKJHvBBsqOI87JU7DH-EttdGdAy-eOVqqdd0U,6557
+exerpy/parser/from_ebsilon/ebsilon_parser.py,sha256=AFfoBiKDTvWRa8hr9ViqmtCIog4QUQZwtYZDnA_tNlQ,31209
+exerpy/parser/from_ebsilon/utils.py,sha256=HB3PyzSN_UqgiScY_Cr4gOPOJdcAjL6hJmgQl4P8-fg,2510
+exerpy/parser/from_tespy/tespy_config.py,sha256=_e8YwJNKAw0O5WRpO92GtVhj-PNziAoYluoOurwI9zs,796
+exerpy-0.0.1.dist-info/licenses/LICENSE,sha256=AZCjT0DYrLExG_BV3UJnoFG1z3CACPxBk-rgcm1as8s,1091
+exerpy-0.0.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+exerpy-0.0.1.dist-info/METADATA,sha256=-tnGmymLpxQ2kcpwgniWq5mPN1sei0L0FNEK7YVU16w,6119
+exerpy-0.0.1.dist-info/RECORD,,

exerpy-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

exerpy-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Sergio Tomasinelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.