OpenPyTEA 1.2.0__tar.gz → 2.0.0__tar.gz

{openpytea-1.2.0/src/OpenPyTEA.egg-info → openpytea-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenPyTEA
-Version: 1.2.0
+Version: 2.0.0
 Summary: OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation
 Maintainer-email: "Panji B. Tamarona" <P.B.Tamarona@tudelft.nl>
 License-Expression: MIT
@@ -26,7 +26,7 @@ Dynamic: license-file
 
 **OpenPyTEA** is an open-source Python toolkit for performing **techno-economic assessment (TEA)** of chemical and energy systems. It was created to address a persistent gap in the TEA workflow: while process simulators model mass and energy balances, researchers often lack an equally transparent and flexible way to evaluate the **economic feasibility** of their designs. Commercial tools remain *black-box tools*, and many academic TEA implementations are process-specific, undocumented, or difficult to reproduce.
 
-**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdown plots**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
+**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdowns**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
 
 Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA platform**. Users can contribute new equipment cost correlations, improve economic models, report issues, and expand the toolkit’s capabilities over time. This collaborative approach helps build a shared, transparent, and continually improving TEA resource—similar to the open-source progress seen in the LCA community.
 
@@ -43,8 +43,10 @@ https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
 ## ✨ Key Features
 - **Modular architecture:** clean separation of cost correlations, equipment objects, plant economics, and uncertainty analysis.  
 - **Transparent and reproducible:** all algorithms, equations, and assumptions are openly available for full traceability.
-- **Cost breakdown visualization:** built-in helpers to plot stacked bar charts of direct equipment costs, fixed capital, and operating costs.
-- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.  
+- **Cost breakdown visualization:** built-in functions to plot stacked bar charts of equipment costs, fixed capital, and operating costs.
+- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.
+- **Workflow using JSON configuration files:** standardized input/output structure via `io.py` for reproducible analyses and multi-scenario evaluation.
+- **Flexible analysis and visualization:** separation of data processing (`analysis.py`) and plotting (`plotting.py`) allows users to apply custom visualization tools.
 - **Interoperable and extensible:** easy integration with process simulators, optimization frameworks, and LCA tools.  
 - **Education-friendly:** ideal for teaching TEA and process design without reliance on proprietary software.  
 - **Community-driven:** users can contribute new correlations, improve models, request features, and shape the evolution of the platform.  
@@ -71,7 +73,6 @@ or with `uv`:
 uv add git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
-
 **OpenPyTEA** requires **Python ≥ 3.9**.  
 The main dependencies include:
 
@@ -91,6 +92,9 @@ src/openpytea/
 ├── equipment.py            # Equipment-level costing and inflation correction
 ├── plant.py                # Plant-level TEA: CAPEX, OPEX, cash flows, financial metrics
 ├── analysis.py             # Sensitivity and uncertainty analysis (sensitivity plots, Monte Carlo)
+├── plotting.py             # Visualization functions (plots and figures)
+├── io.py                   # JSON-based workflow: load inputs and export results
+├── helpers.py              # Helper functions for data handling and common operations
 └── data/                   # Cost correlations database and CEPCI data
 examples/                   # Example notebooks and case studies
 walkthrough.ipynb           # walkthrough of the package
@@ -100,6 +104,14 @@ README.md
 
 ---
 
+## 🏗️ Software Architecture
+
+![OpenPyTEA Architecture](examples/img/architecture.png)
+
+Software architecture and data flow of **OpenPyTEA**, illustrating the progression from user input to TEA output. Users provide economic assumptions, process simulation results, and equipment-sizing parameters. Equipment-sizing information is linked with cost correlations and CEPCI values stored in CSV databases to calculate inflation-adjusted purchased and direct costs. `Equipment` objects are aggregated into a `Plant` object, where CAPEX, OPEX, and financial performance metrics are evaluated. The `analysis.py` module subsequently operates on `Plant` objects to perform sensitivity and uncertainty analyses.
+
+---
+
 ## 🧠 Core Concepts
 
 ### 1. **Equipment-level costing**
@@ -212,14 +224,24 @@ results = monte_carlo(
 Outputs include probability distributions and confidence intervals for LCOP or NPV—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons.
 
 ---
+### 5. **Workflow using JSON configuration files**
+
+**OpenPyTEA** supports a workflow using structured JSON input files via the `io.py` module. This enables standardized, reproducible, and scalable TEA studies.
+
+Key functionalities include:
+- `run_equipment()`: evaluate equipment costs from JSON input
+- `run_plant()`: construct and evaluate a plant configuration
+- `run_tea()`: execute full TEA, including cost breakdowns, sensitivity, and uncertainty analysis
+
+This workflow is demonstrated in `case_study_1_with_JSON.ipynb` in the example folder.
 
 ## 📘 Example Workflows
 
 Example notebooks are available in the `examples/` folder, including:
 
-- Hydrogen production  
-- Hydrogen liquefaction  
-- Geothermal heat and power  
+- Comparison of hydrogen production pathwways 
+- Hydrogen liquefaction precooling system
+- Geothermal-based heating and power generation
 
 Run any example via:
 ```bash
@@ -231,8 +253,6 @@ Each notebook demonstrates:
 - Sensitivity and uncertainty analysis
 - Visualization of key economic indicators
 
----
-
 ## 🧑‍🏫 Educational Use
 
 **OpenPyTEA** is suitable for chemical and process engineering education.

{openpytea-1.2.0 → openpytea-2.0.0}/README.md

@@ -2,7 +2,7 @@
 
 **OpenPyTEA** is an open-source Python toolkit for performing **techno-economic assessment (TEA)** of chemical and energy systems. It was created to address a persistent gap in the TEA workflow: while process simulators model mass and energy balances, researchers often lack an equally transparent and flexible way to evaluate the **economic feasibility** of their designs. Commercial tools remain *black-box tools*, and many academic TEA implementations are process-specific, undocumented, or difficult to reproduce.
 
-**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdown plots**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
+**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdowns**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
 
 Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA platform**. Users can contribute new equipment cost correlations, improve economic models, report issues, and expand the toolkit’s capabilities over time. This collaborative approach helps build a shared, transparent, and continually improving TEA resource—similar to the open-source progress seen in the LCA community.
 
@@ -19,8 +19,10 @@ https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
 ## ✨ Key Features
 - **Modular architecture:** clean separation of cost correlations, equipment objects, plant economics, and uncertainty analysis.  
 - **Transparent and reproducible:** all algorithms, equations, and assumptions are openly available for full traceability.
-- **Cost breakdown visualization:** built-in helpers to plot stacked bar charts of direct equipment costs, fixed capital, and operating costs.
-- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.  
+- **Cost breakdown visualization:** built-in functions to plot stacked bar charts of equipment costs, fixed capital, and operating costs.
+- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.
+- **Workflow using JSON configuration files:** standardized input/output structure via `io.py` for reproducible analyses and multi-scenario evaluation.
+- **Flexible analysis and visualization:** separation of data processing (`analysis.py`) and plotting (`plotting.py`) allows users to apply custom visualization tools.
 - **Interoperable and extensible:** easy integration with process simulators, optimization frameworks, and LCA tools.  
 - **Education-friendly:** ideal for teaching TEA and process design without reliance on proprietary software.  
 - **Community-driven:** users can contribute new correlations, improve models, request features, and shape the evolution of the platform.  
@@ -47,7 +49,6 @@ or with `uv`:
 uv add git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
-
 **OpenPyTEA** requires **Python ≥ 3.9**.  
 The main dependencies include:
 
@@ -67,6 +68,9 @@ src/openpytea/
 ├── equipment.py            # Equipment-level costing and inflation correction
 ├── plant.py                # Plant-level TEA: CAPEX, OPEX, cash flows, financial metrics
 ├── analysis.py             # Sensitivity and uncertainty analysis (sensitivity plots, Monte Carlo)
+├── plotting.py             # Visualization functions (plots and figures)
+├── io.py                   # JSON-based workflow: load inputs and export results
+├── helpers.py              # Helper functions for data handling and common operations
 └── data/                   # Cost correlations database and CEPCI data
 examples/                   # Example notebooks and case studies
 walkthrough.ipynb           # walkthrough of the package
@@ -76,6 +80,14 @@ README.md
 
 ---
 
+## 🏗️ Software Architecture
+
+![OpenPyTEA Architecture](examples/img/architecture.png)
+
+Software architecture and data flow of **OpenPyTEA**, illustrating the progression from user input to TEA output. Users provide economic assumptions, process simulation results, and equipment-sizing parameters. Equipment-sizing information is linked with cost correlations and CEPCI values stored in CSV databases to calculate inflation-adjusted purchased and direct costs. `Equipment` objects are aggregated into a `Plant` object, where CAPEX, OPEX, and financial performance metrics are evaluated. The `analysis.py` module subsequently operates on `Plant` objects to perform sensitivity and uncertainty analyses.
+
+---
+
 ## 🧠 Core Concepts
 
 ### 1. **Equipment-level costing**
@@ -188,14 +200,24 @@ results = monte_carlo(
 Outputs include probability distributions and confidence intervals for LCOP or NPV—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons.
 
 ---
+### 5. **Workflow using JSON configuration files**
+
+**OpenPyTEA** supports a workflow using structured JSON input files via the `io.py` module. This enables standardized, reproducible, and scalable TEA studies.
+
+Key functionalities include:
+- `run_equipment()`: evaluate equipment costs from JSON input
+- `run_plant()`: construct and evaluate a plant configuration
+- `run_tea()`: execute full TEA, including cost breakdowns, sensitivity, and uncertainty analysis
+
+This workflow is demonstrated in `case_study_1_with_JSON.ipynb` in the example folder.
 
 ## 📘 Example Workflows
 
 Example notebooks are available in the `examples/` folder, including:
 
-- Hydrogen production  
-- Hydrogen liquefaction  
-- Geothermal heat and power  
+- Comparison of hydrogen production pathwways 
+- Hydrogen liquefaction precooling system
+- Geothermal-based heating and power generation
 
 Run any example via:
 ```bash
@@ -207,8 +229,6 @@ Each notebook demonstrates:
 - Sensitivity and uncertainty analysis
 - Visualization of key economic indicators
 
----
-
 ## 🧑‍🏫 Educational Use
 
 **OpenPyTEA** is suitable for chemical and process engineering education.

{openpytea-1.2.0 → openpytea-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "OpenPyTEA"
-version = "1.2.0"
+version = "2.0.0"
 description = "OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation"
 readme = "README.md"
 license = "MIT"
@@ -57,3 +57,19 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 openpytea = ["data/*.csv"]
+
+[tool.ruff]
+# Only check Python files (default, but explicit is cleaner)
+extend-include = ["*.py"]
+extend-exclude = ["*.ipynb", "notebooks/", ".ipynb_checkpoints/"]
+
+# Optional but recommended
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W"]  # errors, flakes, warnings
+ignore = []
+
+[tool.ruff.format]
+quote-style = "double"

{openpytea-1.2.0 → openpytea-2.0.0/src/OpenPyTEA.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenPyTEA
-Version: 1.2.0
+Version: 2.0.0
 Summary: OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation
 Maintainer-email: "Panji B. Tamarona" <P.B.Tamarona@tudelft.nl>
 License-Expression: MIT
@@ -26,7 +26,7 @@ Dynamic: license-file
 
 **OpenPyTEA** is an open-source Python toolkit for performing **techno-economic assessment (TEA)** of chemical and energy systems. It was created to address a persistent gap in the TEA workflow: while process simulators model mass and energy balances, researchers often lack an equally transparent and flexible way to evaluate the **economic feasibility** of their designs. Commercial tools remain *black-box tools*, and many academic TEA implementations are process-specific, undocumented, or difficult to reproduce.
 
-**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdown plots**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
+**OpenPyTEA** provides a fully open, modular, and traceable framework that brings TEA into the Python ecosystem. By integrating **equipment cost estimation**, **capital and operating expenditure modeling**, **cash-flow analysis**, **cost breakdowns**, **sensitivity evaluation**, and **Monte Carlo uncertainty propagation**, the toolkit enables users to perform end-to-end TEA with clarity and reproducibility.
 
 Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA platform**. Users can contribute new equipment cost correlations, improve economic models, report issues, and expand the toolkit’s capabilities over time. This collaborative approach helps build a shared, transparent, and continually improving TEA resource—similar to the open-source progress seen in the LCA community.
 
@@ -43,8 +43,10 @@ https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
 ## ✨ Key Features
 - **Modular architecture:** clean separation of cost correlations, equipment objects, plant economics, and uncertainty analysis.  
 - **Transparent and reproducible:** all algorithms, equations, and assumptions are openly available for full traceability.
-- **Cost breakdown visualization:** built-in helpers to plot stacked bar charts of direct equipment costs, fixed capital, and operating costs.
-- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.  
+- **Cost breakdown visualization:** built-in functions to plot stacked bar charts of equipment costs, fixed capital, and operating costs.
+- **Built-in uncertainty tools:** automatic generation of sensitivity plots and Monte Carlo simulations.
+- **Workflow using JSON configuration files:** standardized input/output structure via `io.py` for reproducible analyses and multi-scenario evaluation.
+- **Flexible analysis and visualization:** separation of data processing (`analysis.py`) and plotting (`plotting.py`) allows users to apply custom visualization tools.
 - **Interoperable and extensible:** easy integration with process simulators, optimization frameworks, and LCA tools.  
 - **Education-friendly:** ideal for teaching TEA and process design without reliance on proprietary software.  
 - **Community-driven:** users can contribute new correlations, improve models, request features, and shape the evolution of the platform.  
@@ -71,7 +73,6 @@ or with `uv`:
 uv add git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
-
 **OpenPyTEA** requires **Python ≥ 3.9**.  
 The main dependencies include:
 
@@ -91,6 +92,9 @@ src/openpytea/
 ├── equipment.py            # Equipment-level costing and inflation correction
 ├── plant.py                # Plant-level TEA: CAPEX, OPEX, cash flows, financial metrics
 ├── analysis.py             # Sensitivity and uncertainty analysis (sensitivity plots, Monte Carlo)
+├── plotting.py             # Visualization functions (plots and figures)
+├── io.py                   # JSON-based workflow: load inputs and export results
+├── helpers.py              # Helper functions for data handling and common operations
 └── data/                   # Cost correlations database and CEPCI data
 examples/                   # Example notebooks and case studies
 walkthrough.ipynb           # walkthrough of the package
@@ -100,6 +104,14 @@ README.md
 
 ---
 
+## 🏗️ Software Architecture
+
+![OpenPyTEA Architecture](examples/img/architecture.png)
+
+Software architecture and data flow of **OpenPyTEA**, illustrating the progression from user input to TEA output. Users provide economic assumptions, process simulation results, and equipment-sizing parameters. Equipment-sizing information is linked with cost correlations and CEPCI values stored in CSV databases to calculate inflation-adjusted purchased and direct costs. `Equipment` objects are aggregated into a `Plant` object, where CAPEX, OPEX, and financial performance metrics are evaluated. The `analysis.py` module subsequently operates on `Plant` objects to perform sensitivity and uncertainty analyses.
+
+---
+
 ## 🧠 Core Concepts
 
 ### 1. **Equipment-level costing**
@@ -212,14 +224,24 @@ results = monte_carlo(
 Outputs include probability distributions and confidence intervals for LCOP or NPV—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons.
 
 ---
+### 5. **Workflow using JSON configuration files**
+
+**OpenPyTEA** supports a workflow using structured JSON input files via the `io.py` module. This enables standardized, reproducible, and scalable TEA studies.
+
+Key functionalities include:
+- `run_equipment()`: evaluate equipment costs from JSON input
+- `run_plant()`: construct and evaluate a plant configuration
+- `run_tea()`: execute full TEA, including cost breakdowns, sensitivity, and uncertainty analysis
+
+This workflow is demonstrated in `case_study_1_with_JSON.ipynb` in the example folder.
 
 ## 📘 Example Workflows
 
 Example notebooks are available in the `examples/` folder, including:
 
-- Hydrogen production  
-- Hydrogen liquefaction  
-- Geothermal heat and power  
+- Comparison of hydrogen production pathwways 
+- Hydrogen liquefaction precooling system
+- Geothermal-based heating and power generation
 
 Run any example via:
 ```bash
@@ -231,8 +253,6 @@ Each notebook demonstrates:
 - Sensitivity and uncertainty analysis
 - Visualization of key economic indicators
 
----
-
 ## 🧑‍🏫 Educational Use
 
 **OpenPyTEA** is suitable for chemical and process engineering education.

{openpytea-1.2.0 → openpytea-2.0.0}/src/OpenPyTEA.egg-info/SOURCES.txt

@@ -9,7 +9,15 @@ src/OpenPyTEA.egg-info/top_level.txt
 src/openpytea/__init__.py
 src/openpytea/analysis.py
 src/openpytea/equipment.py
+src/openpytea/helpers.py
+src/openpytea/io.py
 src/openpytea/plant.py
+src/openpytea/plotting.py
 src/openpytea/data/cepci_values.csv
 src/openpytea/data/cost_correlations.csv
-tests/test_import.py
+tests/test_analysis.py
+tests/test_equipment.py
+tests/test_plant.py
+tests/test_plotting.py
+tests/test_run_tea.py
+tests/test_smoke.py

openpytea-2.0.0/src/openpytea/__init__.py

@@ -0,0 +1,36 @@
+from .plant import Plant
+from .equipment import Equipment
+from .analysis import (direct_costs_data, fixed_capital_data,
+                       fixed_opex_data, variable_opex_data,
+                       sensitivity_data, tornado_data,
+                       monte_carlo)
+from .plotting import (plot_stacked_bar, plot_sensitivity,
+                       plot_tornado, plot_monte_carlo,
+                       plot_monte_carlo_inputs,
+                       plot_multiple_monte_carlo)
+
+from .io import (load_results, run_equipment, run_plant, run_tea)
+
+__version__ = "2.0.0"
+
+__all__ = [
+    "Plant",
+    "Equipment",
+    "direct_costs_data",
+    "fixed_capital_data",
+    "fixed_opex_data",
+    "variable_opex_data",
+    "sensitivity_data",
+    "tornado_data",
+    "monte_carlo",
+    "plot_stacked_bar",
+    "plot_sensitivity",
+    "plot_tornado",
+    "plot_monte_carlo",
+    "plot_monte_carlo_inputs",
+    "plot_multiple_monte_carlo",
+    "load_results",
+    "run_equipment",
+    "run_plant",
+    "run_tea"
+]