OpenPyTEA 3.2.1__tar.gz → 3.2.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. {openpytea-3.2.1/src/OpenPyTEA.egg-info → openpytea-3.2.3}/PKG-INFO +25 -34
  2. {openpytea-3.2.1 → openpytea-3.2.3}/README.md +23 -33
  3. {openpytea-3.2.1 → openpytea-3.2.3}/pyproject.toml +14 -1
  4. {openpytea-3.2.1 → openpytea-3.2.3/src/OpenPyTEA.egg-info}/PKG-INFO +25 -34
  5. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/__init__.py +17 -2
  6. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/analysis.py +126 -31
  7. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/cli.py +11 -1
  8. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/data/cost_correlations.csv +431 -421
  9. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/equipment.py +733 -37
  10. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/helpers.py +8 -2
  11. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/io.py +257 -5
  12. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/plant.py +378 -74
  13. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/plotting.py +376 -79
  14. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_analysis.py +44 -0
  15. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_composite_equipment.py +13 -0
  16. openpytea-3.2.3/tests/test_equipment.py +286 -0
  17. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_plant.py +159 -2
  18. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_plotting.py +141 -8
  19. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_run_tea.py +123 -0
  20. openpytea-3.2.1/tests/test_equipment.py +0 -111
  21. {openpytea-3.2.1 → openpytea-3.2.3}/LICENSE +0 -0
  22. {openpytea-3.2.1 → openpytea-3.2.3}/setup.cfg +0 -0
  23. {openpytea-3.2.1 → openpytea-3.2.3}/src/OpenPyTEA.egg-info/SOURCES.txt +0 -0
  24. {openpytea-3.2.1 → openpytea-3.2.3}/src/OpenPyTEA.egg-info/dependency_links.txt +0 -0
  25. {openpytea-3.2.1 → openpytea-3.2.3}/src/OpenPyTEA.egg-info/entry_points.txt +0 -0
  26. {openpytea-3.2.1 → openpytea-3.2.3}/src/OpenPyTEA.egg-info/requires.txt +0 -0
  27. {openpytea-3.2.1 → openpytea-3.2.3}/src/OpenPyTEA.egg-info/top_level.txt +0 -0
  28. {openpytea-3.2.1 → openpytea-3.2.3}/src/openpytea/data/cepci_values.csv +0 -0
  29. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_cli.py +0 -0
  30. {openpytea-3.2.1 → openpytea-3.2.3}/tests/test_smoke.py +0 -0
@@ -1,11 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: OpenPyTEA
3
- Version: 3.2.1
3
+ Version: 3.2.3
4
4
  Summary: OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation
5
5
  Maintainer-email: "Panji B. Tamarona" <P.B.Tamarona@tudelft.nl>
6
6
  License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/pbtamarona/OpenPyTEA
8
8
  Project-URL: Documentation, https://openpytea.readthedocs.io
9
+ Project-URL: Desktop app, https://github.com/pbtamarona/OpenPyTEA/releases/latest
9
10
  Project-URL: Changelog, https://github.com/pbtamarona/OpenPyTEA/releases
10
11
  Project-URL: Issues, https://github.com/pbtamarona/OpenPyTEA/issues
11
12
  Keywords: chemical-engineering,process-design,power-plant,techno-economic-analysis,process-plant
@@ -47,25 +48,8 @@ https://openpytea.readthedocs.io
47
48
  **For some case-study examples, please check the `examples` folder:**
48
49
  https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
49
50
 
50
- ---
51
- ## 🎓 Workshop
52
-
53
- We are hosting a one-day workshop on open-science techno-economic assessment using **OpenPyTEA**!
54
-
55
- <p align="center">
56
- <img src="https://raw.githubusercontent.com/pbtamarona/OpenPyTEA/main/workshop-flyer.jpg" alt="OpenPyTEA" width="800"/>
57
- </p>
58
-
59
- **Open-Science Techno-Economic Assessment with OpenPyTEA: From Process Design to Economic Insights**
60
-
61
- The workshop covers the full workflow from process design and simulation to economic evaluation, combining lectures, a hands-on session with OpenPyTEA, and an industry talk by Shell. It closes with a community discussion on establishing shared TEA standards, bringing together students, researchers, engineers, and policymakers across chemical, energy, and sustainability sciences.
62
-
63
- - 📅 **Date:** November 6, 2026 | 09:30 – 18:00
64
- - 📍 **Location:** Process & Energy, TU Delft, Delft, The Netherlands
65
- - 📝 **Registration:** [aanmelder.nl/openpytea2026](https://aanmelder.nl/openpytea2026)
66
- - ⏰ **Deadline:** $${\color{red}\textbf{Registration closes on October 15, 2026}}$$
67
-
68
- Lunch, snacks, coffee, and drinks will be provided!
51
+ **To use OpenPyTEA without writing code, download the desktop app for Windows or macOS** (installing is explained in the Graphical User Interface section below):
52
+ https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3
69
53
 
70
54
  ---
71
55
  ## ✨ Key Features
@@ -158,16 +142,20 @@ Software architecture and data flow of **OpenPyTEA**, illustrating the progressi
158
142
  ---
159
143
  ## 🖥️ Graphical User Interface
160
144
 
161
- > **Note:** The GUI is still in development and may not yet offer all the features of the Python package.
145
+ An optional desktop app provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. No Python or Node.js required.
162
146
 
163
- An optional graphical interface provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. It can be installed as a standalone desktop app — installers for **Windows** (`.exe`/`.msi`) and **macOS** (`.dmg`) are available on the [Releases page](https://github.com/pbtamarona/OpenPyTEA/releases), with no Python or Node.js required — or run from source as a FastAPI + React application.
147
+ **Download** the installer for your platform from the **[OpenPyTEA 3.2.3 release](https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3)**:
164
148
 
165
- The GUI's source, installer build, setup instructions, and architecture documentation live on the [`standalone-package`](https://github.com/pbtamarona/OpenPyTEA/tree/standalone-package) branch:
149
+ | Platform | File |
150
+ |---|---|
151
+ | **Windows** (x64) | `OpenPyTEA_3.2.3_x64-setup.exe` (or the `.msi`) |
152
+ | **macOS** (Apple Silicon) | `OpenPyTEA_3.2.3_aarch64.dmg` |
166
153
 
167
- ```bash
168
- git fetch origin
169
- git checkout standalone-package
170
- ```
154
+ **Install:**
155
+ - **Windows:** run the `.exe` and follow the setup wizard. If SmartScreen shows *"Windows protected your PC"* (the app isn't code-signed), click **More info** → **Run anyway**.
156
+ - **macOS:** open the `.dmg` and drag OpenPyTEA into **Applications**. Before the first launch, run `xattr -dr com.apple.quarantine /Applications/OpenPyTEA.app` once in Terminal (the app isn't code-signed).
157
+
158
+ Then click **Examples** in the app to load a case study and explore. To run the GUI from source, see the [GUI page of the docs](https://openpytea.readthedocs.io/en/latest/gui.html#running-from-source); to build the installers yourself, see [GUI development](https://openpytea.readthedocs.io/en/latest/gui_development.html).
171
159
 
172
160
  ---
173
161
  ## 🧠 Core Concepts
@@ -183,7 +171,7 @@ compressor = Equipment(
183
171
  name='COMP',
184
172
  param=5000, # kW
185
173
  process_type='Fluids',
186
- category='Compressors, fans, & Blowers',
174
+ category='Compressors, fans, & blowers',
187
175
  type='Compressor, centrifugal',
188
176
  material='Carbon steel'
189
177
  )
@@ -212,9 +200,10 @@ psa.breakdown() # one row per sub-component
212
200
  Multiple equipment objects can be grouped into a `Plant` instance for full TEA
213
201
 
214
202
  ```python
215
- from openpytea.plant import Plant
203
+ from openpytea.plant import Plant, PlantConfig
216
204
 
217
- ammonia_plant = Plant({
205
+ # The PlantConfig annotation is optional; it lets your editor complete keys and flag typos
206
+ config: PlantConfig = {
218
207
  'plant_name': 'Ammonia Production Plant',
219
208
  'country': 'Netherlands',
220
209
  'process_type': 'Fluids',
@@ -237,8 +226,9 @@ ammonia_plant = Plant({
237
226
  'price': 2 # US$/kg
238
227
  },
239
228
  },
240
- })
229
+ }
241
230
 
231
+ ammonia_plant = Plant(config)
242
232
  ammonia_plant.calculate_cash_flow(print_results=True)
243
233
  ammonia_plant.calculate_levelized_cost()
244
234
  ```
@@ -317,12 +307,13 @@ Pass `include_process_params=True` to rank consumption and production quantities
317
307
  Monte Carlo Simulation
318
308
  ```python
319
309
  from openpytea.analysis import monte_carlo
320
- from openpytea.plotting import plot_monte_carlo
310
+ from openpytea.plotting import plot_monte_carlo, plot_monte_carlo_cumulative
321
311
 
322
312
  results = monte_carlo(ammonia_plant, num_samples=1_000_000)
323
- fig, ax = plot_monte_carlo(results)
313
+ fig, ax = plot_monte_carlo(results) # histogram
314
+ fig, ax = plot_monte_carlo_cumulative(results) # cumulative distribution
324
315
  ```
325
- Outputs include probability distributions and confidence intervals for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
316
+ Outputs include probability distributions for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. Both plots mark the P10, P50 and P90 and list their values; the cumulative plot also reads probabilities such as "P(LCOP ≤ x)" straight off the curve. Given a list of plants, either function compares Monte Carlo results for multiple plants on one plot. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
326
317
 
327
318
  Uncertainty is configured per item: `price_uncertainty` on any `variable_opex_inputs` or `plant_products` entry, `consumption_uncertainty`/`production_uncertainty` for the quantities, and `project_uncertainties` for the project-level scalars.
328
319
 
@@ -19,25 +19,8 @@ https://openpytea.readthedocs.io
19
19
  **For some case-study examples, please check the `examples` folder:**
20
20
  https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
21
21
 
22
- ---
23
- ## 🎓 Workshop
24
-
25
- We are hosting a one-day workshop on open-science techno-economic assessment using **OpenPyTEA**!
26
-
27
- <p align="center">
28
- <img src="https://raw.githubusercontent.com/pbtamarona/OpenPyTEA/main/workshop-flyer.jpg" alt="OpenPyTEA" width="800"/>
29
- </p>
30
-
31
- **Open-Science Techno-Economic Assessment with OpenPyTEA: From Process Design to Economic Insights**
32
-
33
- The workshop covers the full workflow from process design and simulation to economic evaluation, combining lectures, a hands-on session with OpenPyTEA, and an industry talk by Shell. It closes with a community discussion on establishing shared TEA standards, bringing together students, researchers, engineers, and policymakers across chemical, energy, and sustainability sciences.
34
-
35
- - 📅 **Date:** November 6, 2026 | 09:30 – 18:00
36
- - 📍 **Location:** Process & Energy, TU Delft, Delft, The Netherlands
37
- - 📝 **Registration:** [aanmelder.nl/openpytea2026](https://aanmelder.nl/openpytea2026)
38
- - ⏰ **Deadline:** $${\color{red}\textbf{Registration closes on October 15, 2026}}$$
39
-
40
- Lunch, snacks, coffee, and drinks will be provided!
22
+ **To use OpenPyTEA without writing code, download the desktop app for Windows or macOS** (installing is explained in the Graphical User Interface section below):
23
+ https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3
41
24
 
42
25
  ---
43
26
  ## ✨ Key Features
@@ -130,16 +113,20 @@ Software architecture and data flow of **OpenPyTEA**, illustrating the progressi
130
113
  ---
131
114
  ## 🖥️ Graphical User Interface
132
115
 
133
- > **Note:** The GUI is still in development and may not yet offer all the features of the Python package.
116
+ An optional desktop app provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. No Python or Node.js required.
134
117
 
135
- An optional graphical interface provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. It can be installed as a standalone desktop app — installers for **Windows** (`.exe`/`.msi`) and **macOS** (`.dmg`) are available on the [Releases page](https://github.com/pbtamarona/OpenPyTEA/releases), with no Python or Node.js required — or run from source as a FastAPI + React application.
118
+ **Download** the installer for your platform from the **[OpenPyTEA 3.2.3 release](https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3)**:
136
119
 
137
- The GUI's source, installer build, setup instructions, and architecture documentation live on the [`standalone-package`](https://github.com/pbtamarona/OpenPyTEA/tree/standalone-package) branch:
120
+ | Platform | File |
121
+ |---|---|
122
+ | **Windows** (x64) | `OpenPyTEA_3.2.3_x64-setup.exe` (or the `.msi`) |
123
+ | **macOS** (Apple Silicon) | `OpenPyTEA_3.2.3_aarch64.dmg` |
138
124
 
139
- ```bash
140
- git fetch origin
141
- git checkout standalone-package
142
- ```
125
+ **Install:**
126
+ - **Windows:** run the `.exe` and follow the setup wizard. If SmartScreen shows *"Windows protected your PC"* (the app isn't code-signed), click **More info** → **Run anyway**.
127
+ - **macOS:** open the `.dmg` and drag OpenPyTEA into **Applications**. Before the first launch, run `xattr -dr com.apple.quarantine /Applications/OpenPyTEA.app` once in Terminal (the app isn't code-signed).
128
+
129
+ Then click **Examples** in the app to load a case study and explore. To run the GUI from source, see the [GUI page of the docs](https://openpytea.readthedocs.io/en/latest/gui.html#running-from-source); to build the installers yourself, see [GUI development](https://openpytea.readthedocs.io/en/latest/gui_development.html).
143
130
 
144
131
  ---
145
132
  ## 🧠 Core Concepts
@@ -155,7 +142,7 @@ compressor = Equipment(
155
142
  name='COMP',
156
143
  param=5000, # kW
157
144
  process_type='Fluids',
158
- category='Compressors, fans, & Blowers',
145
+ category='Compressors, fans, & blowers',
159
146
  type='Compressor, centrifugal',
160
147
  material='Carbon steel'
161
148
  )
@@ -184,9 +171,10 @@ psa.breakdown() # one row per sub-component
184
171
  Multiple equipment objects can be grouped into a `Plant` instance for full TEA
185
172
 
186
173
  ```python
187
- from openpytea.plant import Plant
174
+ from openpytea.plant import Plant, PlantConfig
188
175
 
189
- ammonia_plant = Plant({
176
+ # The PlantConfig annotation is optional; it lets your editor complete keys and flag typos
177
+ config: PlantConfig = {
190
178
  'plant_name': 'Ammonia Production Plant',
191
179
  'country': 'Netherlands',
192
180
  'process_type': 'Fluids',
@@ -209,8 +197,9 @@ ammonia_plant = Plant({
209
197
  'price': 2 # US$/kg
210
198
  },
211
199
  },
212
- })
200
+ }
213
201
 
202
+ ammonia_plant = Plant(config)
214
203
  ammonia_plant.calculate_cash_flow(print_results=True)
215
204
  ammonia_plant.calculate_levelized_cost()
216
205
  ```
@@ -289,12 +278,13 @@ Pass `include_process_params=True` to rank consumption and production quantities
289
278
  Monte Carlo Simulation
290
279
  ```python
291
280
  from openpytea.analysis import monte_carlo
292
- from openpytea.plotting import plot_monte_carlo
281
+ from openpytea.plotting import plot_monte_carlo, plot_monte_carlo_cumulative
293
282
 
294
283
  results = monte_carlo(ammonia_plant, num_samples=1_000_000)
295
- fig, ax = plot_monte_carlo(results)
284
+ fig, ax = plot_monte_carlo(results) # histogram
285
+ fig, ax = plot_monte_carlo_cumulative(results) # cumulative distribution
296
286
  ```
297
- Outputs include probability distributions and confidence intervals for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
287
+ Outputs include probability distributions for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. Both plots mark the P10, P50 and P90 and list their values; the cumulative plot also reads probabilities such as "P(LCOP ≤ x)" straight off the curve. Given a list of plants, either function compares Monte Carlo results for multiple plants on one plot. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
298
288
 
299
289
  Uncertainty is configured per item: `price_uncertainty` on any `variable_opex_inputs` or `plant_products` entry, `consumption_uncertainty`/`production_uncertainty` for the quantities, and `project_uncertainties` for the project-level scalars.
300
290
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "OpenPyTEA"
3
- version = "3.2.1"
3
+ version = "3.2.3"
4
4
  description = "OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation"
5
5
  readme = "README.md"
6
6
  license = "MIT"
@@ -31,6 +31,7 @@ maintainers = [
31
31
  [project.urls]
32
32
  Homepage = "https://github.com/pbtamarona/OpenPyTEA"
33
33
  Documentation = "https://openpytea.readthedocs.io"
34
+ "Desktop app" = "https://github.com/pbtamarona/OpenPyTEA/releases/latest"
34
35
  Changelog = "https://github.com/pbtamarona/OpenPyTEA/releases"
35
36
  Issues = "https://github.com/pbtamarona/OpenPyTEA/issues"
36
37
 
@@ -82,3 +83,15 @@ ignore = []
82
83
 
83
84
  [tool.ruff.format]
84
85
  quote-style = "double"
86
+
87
+ # Type checking, read by VS Code's Pylance and by the pyright CLI
88
+ # (`npx pyright` from the repo root)
89
+ [tool.pyright]
90
+ typeCheckingMode = "basic"
91
+ pythonVersion = "3.10"
92
+ venvPath = "."
93
+ venv = ".venv"
94
+ # The notebooks use `from openpytea.analysis import *` on purpose
95
+ reportWildcardImportFromLibrary = false
96
+ # Don't report type-check diagnostics in notebooks (they're user-facing examples)
97
+ ignore = ["**/*.ipynb"]
@@ -1,11 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: OpenPyTEA
3
- Version: 3.2.1
3
+ Version: 3.2.3
4
4
  Summary: OpenPyTEA: An open-source Python toolkit for techno-economic assessment of process plants with economic sensitivity and uncertainty evaluation
5
5
  Maintainer-email: "Panji B. Tamarona" <P.B.Tamarona@tudelft.nl>
6
6
  License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/pbtamarona/OpenPyTEA
8
8
  Project-URL: Documentation, https://openpytea.readthedocs.io
9
+ Project-URL: Desktop app, https://github.com/pbtamarona/OpenPyTEA/releases/latest
9
10
  Project-URL: Changelog, https://github.com/pbtamarona/OpenPyTEA/releases
10
11
  Project-URL: Issues, https://github.com/pbtamarona/OpenPyTEA/issues
11
12
  Keywords: chemical-engineering,process-design,power-plant,techno-economic-analysis,process-plant
@@ -47,25 +48,8 @@ https://openpytea.readthedocs.io
47
48
  **For some case-study examples, please check the `examples` folder:**
48
49
  https://github.com/pbtamarona/OpenPyTEA/tree/main/examples
49
50
 
50
- ---
51
- ## 🎓 Workshop
52
-
53
- We are hosting a one-day workshop on open-science techno-economic assessment using **OpenPyTEA**!
54
-
55
- <p align="center">
56
- <img src="https://raw.githubusercontent.com/pbtamarona/OpenPyTEA/main/workshop-flyer.jpg" alt="OpenPyTEA" width="800"/>
57
- </p>
58
-
59
- **Open-Science Techno-Economic Assessment with OpenPyTEA: From Process Design to Economic Insights**
60
-
61
- The workshop covers the full workflow from process design and simulation to economic evaluation, combining lectures, a hands-on session with OpenPyTEA, and an industry talk by Shell. It closes with a community discussion on establishing shared TEA standards, bringing together students, researchers, engineers, and policymakers across chemical, energy, and sustainability sciences.
62
-
63
- - 📅 **Date:** November 6, 2026 | 09:30 – 18:00
64
- - 📍 **Location:** Process & Energy, TU Delft, Delft, The Netherlands
65
- - 📝 **Registration:** [aanmelder.nl/openpytea2026](https://aanmelder.nl/openpytea2026)
66
- - ⏰ **Deadline:** $${\color{red}\textbf{Registration closes on October 15, 2026}}$$
67
-
68
- Lunch, snacks, coffee, and drinks will be provided!
51
+ **To use OpenPyTEA without writing code, download the desktop app for Windows or macOS** (installing is explained in the Graphical User Interface section below):
52
+ https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3
69
53
 
70
54
  ---
71
55
  ## ✨ Key Features
@@ -158,16 +142,20 @@ Software architecture and data flow of **OpenPyTEA**, illustrating the progressi
158
142
  ---
159
143
  ## 🖥️ Graphical User Interface
160
144
 
161
- > **Note:** The GUI is still in development and may not yet offer all the features of the Python package.
145
+ An optional desktop app provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. No Python or Node.js required.
162
146
 
163
- An optional graphical interface provides the full TEA workflow — equipment costing, plant configuration, results, sensitivity/tornado analysis, Monte Carlo, and multi-plant comparison — without writing Python code. It can be installed as a standalone desktop app — installers for **Windows** (`.exe`/`.msi`) and **macOS** (`.dmg`) are available on the [Releases page](https://github.com/pbtamarona/OpenPyTEA/releases), with no Python or Node.js required — or run from source as a FastAPI + React application.
147
+ **Download** the installer for your platform from the **[OpenPyTEA 3.2.3 release](https://github.com/pbtamarona/OpenPyTEA/releases/tag/v3.2.3)**:
164
148
 
165
- The GUI's source, installer build, setup instructions, and architecture documentation live on the [`standalone-package`](https://github.com/pbtamarona/OpenPyTEA/tree/standalone-package) branch:
149
+ | Platform | File |
150
+ |---|---|
151
+ | **Windows** (x64) | `OpenPyTEA_3.2.3_x64-setup.exe` (or the `.msi`) |
152
+ | **macOS** (Apple Silicon) | `OpenPyTEA_3.2.3_aarch64.dmg` |
166
153
 
167
- ```bash
168
- git fetch origin
169
- git checkout standalone-package
170
- ```
154
+ **Install:**
155
+ - **Windows:** run the `.exe` and follow the setup wizard. If SmartScreen shows *"Windows protected your PC"* (the app isn't code-signed), click **More info** → **Run anyway**.
156
+ - **macOS:** open the `.dmg` and drag OpenPyTEA into **Applications**. Before the first launch, run `xattr -dr com.apple.quarantine /Applications/OpenPyTEA.app` once in Terminal (the app isn't code-signed).
157
+
158
+ Then click **Examples** in the app to load a case study and explore. To run the GUI from source, see the [GUI page of the docs](https://openpytea.readthedocs.io/en/latest/gui.html#running-from-source); to build the installers yourself, see [GUI development](https://openpytea.readthedocs.io/en/latest/gui_development.html).
171
159
 
172
160
  ---
173
161
  ## 🧠 Core Concepts
@@ -183,7 +171,7 @@ compressor = Equipment(
183
171
  name='COMP',
184
172
  param=5000, # kW
185
173
  process_type='Fluids',
186
- category='Compressors, fans, & Blowers',
174
+ category='Compressors, fans, & blowers',
187
175
  type='Compressor, centrifugal',
188
176
  material='Carbon steel'
189
177
  )
@@ -212,9 +200,10 @@ psa.breakdown() # one row per sub-component
212
200
  Multiple equipment objects can be grouped into a `Plant` instance for full TEA
213
201
 
214
202
  ```python
215
- from openpytea.plant import Plant
203
+ from openpytea.plant import Plant, PlantConfig
216
204
 
217
- ammonia_plant = Plant({
205
+ # The PlantConfig annotation is optional; it lets your editor complete keys and flag typos
206
+ config: PlantConfig = {
218
207
  'plant_name': 'Ammonia Production Plant',
219
208
  'country': 'Netherlands',
220
209
  'process_type': 'Fluids',
@@ -237,8 +226,9 @@ ammonia_plant = Plant({
237
226
  'price': 2 # US$/kg
238
227
  },
239
228
  },
240
- })
229
+ }
241
230
 
231
+ ammonia_plant = Plant(config)
242
232
  ammonia_plant.calculate_cash_flow(print_results=True)
243
233
  ammonia_plant.calculate_levelized_cost()
244
234
  ```
@@ -317,12 +307,13 @@ Pass `include_process_params=True` to rank consumption and production quantities
317
307
  Monte Carlo Simulation
318
308
  ```python
319
309
  from openpytea.analysis import monte_carlo
320
- from openpytea.plotting import plot_monte_carlo
310
+ from openpytea.plotting import plot_monte_carlo, plot_monte_carlo_cumulative
321
311
 
322
312
  results = monte_carlo(ammonia_plant, num_samples=1_000_000)
323
- fig, ax = plot_monte_carlo(results)
313
+ fig, ax = plot_monte_carlo(results) # histogram
314
+ fig, ax = plot_monte_carlo_cumulative(results) # cumulative distribution
324
315
  ```
325
- Outputs include probability distributions and confidence intervals for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. With `plot_multiple_monte_carlo`, **OpenPyTEA** can also visualize Monte Carlo results for multiple plants to enable uncertainty comparisons. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
316
+ Outputs include probability distributions for LCOP, NPV, ROI, and payback time—supporting uncertainty-informed decision-making. Both plots mark the P10, P50 and P90 and list their values; the cumulative plot also reads probabilities such as "P(LCOP ≤ x)" straight off the curve. Given a list of plants, either function compares Monte Carlo results for multiple plants on one plot. `plot_monte_carlo_inputs` shows the sampled inputs themselves, split into **process** and **economic** figures, to confirm each distribution came out as intended.
326
317
 
327
318
  Uncertainty is configured per item: `price_uncertainty` on any `variable_opex_inputs` or `plant_products` entry, `consumption_uncertainty`/`production_uncertainty` for the quantities, and `project_uncertainties` for the project-level scalars.
328
319
 
@@ -5,8 +5,11 @@ economic sensitivity and uncertainty evaluation.
5
5
 
6
6
  from importlib.metadata import version
7
7
 
8
- from .plant import Plant
9
- from .equipment import Equipment, CompositeEquipment, inflation_adjustment
8
+ from .plant import (Plant, PlantConfig, OpexInput, ProductInput,
9
+ Uncertainty, Dependency)
10
+ from .equipment import (Equipment, CompositeEquipment, inflation_adjustment,
11
+ equipment_options, ProcessType, Category,
12
+ EquipmentType, Material)
10
13
  from .analysis import (direct_costs_data, fixed_capital_data,
11
14
  fixed_opex_data, variable_opex_data,
12
15
  levelized_cost_data, cash_flow_data,
@@ -15,6 +18,7 @@ from .analysis import (direct_costs_data, fixed_capital_data,
15
18
  from .plotting import (plot_stacked_bar, plot_cash_flow,
16
19
  plot_sensitivity,
17
20
  plot_tornado, plot_monte_carlo,
21
+ plot_monte_carlo_cumulative,
18
22
  plot_monte_carlo_inputs,
19
23
  plot_multiple_monte_carlo)
20
24
 
@@ -27,9 +31,19 @@ __license__ = "MIT"
27
31
 
28
32
  __all__ = [
29
33
  "Plant",
34
+ "PlantConfig",
35
+ "OpexInput",
36
+ "ProductInput",
37
+ "Uncertainty",
38
+ "Dependency",
30
39
  "Equipment",
31
40
  "CompositeEquipment",
32
41
  "inflation_adjustment",
42
+ "equipment_options",
43
+ "ProcessType",
44
+ "Category",
45
+ "EquipmentType",
46
+ "Material",
33
47
  "direct_costs_data",
34
48
  "fixed_capital_data",
35
49
  "fixed_opex_data",
@@ -44,6 +58,7 @@ __all__ = [
44
58
  "plot_sensitivity",
45
59
  "plot_tornado",
46
60
  "plot_monte_carlo",
61
+ "plot_monte_carlo_cumulative",
47
62
  "plot_monte_carlo_inputs",
48
63
  "plot_multiple_monte_carlo",
49
64
  "load_results",