OpenPyTEA 3.0.0__tar.gz → 3.1.0__tar.gz

{openpytea-3.0.0/src/OpenPyTEA.egg-info → openpytea-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenPyTEA
-Version: 3.0.0
+Version: 3.1.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
@@ -34,8 +34,8 @@ Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA plat
 
 Whether used for early-stage process design, technology screening, or teaching, **OpenPyTEA** makes TEA more accessible, consistent, and aligned with FAIR research principles (Findable, Accessible, Interoperable, and Reusable).
 
-**For a full walkthrough of the features and usage of OpenPyTEA, refer to the `walkthrough.ipynb` notebook**:  
-https://github.com/pbtamarona/OpenPyTEA/blob/main/walkthrough.ipynb
+**For a full walkthrough of the features and usage of OpenPyTEA, refer to the notebooks in the `walkthrough` folder** (five parts, from equipment costing to Monte Carlo analysis):  
+https://github.com/pbtamarona/OpenPyTEA/tree/main/walkthrough
 
 **For the full documentation of the package, visit the ReadTheDocs page:**  
 https://openpytea.readthedocs.io
@@ -86,16 +86,34 @@ Lunch, snacks, coffee, and drinks will be provided!
 pip install openpytea
 ```
 
+If you work in Jupyter notebooks or want to run the walkthrough and example notebooks, we recommend installing with the `ipython` extra:
+
+```bash
+pip install "openpytea[ipython]"
+```
+
+The difference:
+
+- `pip install openpytea` installs the core package. This is enough for Python scripts and the command-line interface.
+- `pip install "openpytea[ipython]"` also installs `ipython` and `ipywidgets`, which OpenPyTEA uses to show a live progress bar in notebooks during Monte Carlo runs. Without them, the progress bar falls back to plain text and Jupyter shows a warning. Jupyter itself is not included; install it separately if needed (e.g. `pip install jupyter`).
+
 ### 2. **Install from GitHub (development version)**
 
 ```bash
 pip install git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
+or, with the `ipython` extra for notebooks:
+
+```bash
+pip install "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"
+```
+
 or with `uv`:
 
 ```bash
 uv add git+https://github.com/pbtamarona/OpenPyTEA
+uv add "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"  # with notebook extras
 ```
 
 **OpenPyTEA** requires **Python ≥ 3.10**.  
@@ -121,7 +139,7 @@ src/openpytea/
 ├── 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
+walkthrough/                # Walkthrough of the package, split into five notebooks (part_1 ... part_5)
 pyproject.toml
 README.md
 ```
@@ -260,7 +278,7 @@ cash_flow = cash_flow_data(ammonia_plant)
 fig, ax = plot_cash_flow(cash_flow)
 ```
 
-As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`/`payback_time`) for use outside the plot, e.g. in reports.
+As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`) for use outside the plot, e.g. in reports.
 
 ### 5. **Sensitivity and uncertainty analysis**
 

{openpytea-3.0.0 → openpytea-3.1.0}/README.md

@@ -10,8 +10,8 @@ Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA plat
 
 Whether used for early-stage process design, technology screening, or teaching, **OpenPyTEA** makes TEA more accessible, consistent, and aligned with FAIR research principles (Findable, Accessible, Interoperable, and Reusable).
 
-**For a full walkthrough of the features and usage of OpenPyTEA, refer to the `walkthrough.ipynb` notebook**:  
-https://github.com/pbtamarona/OpenPyTEA/blob/main/walkthrough.ipynb
+**For a full walkthrough of the features and usage of OpenPyTEA, refer to the notebooks in the `walkthrough` folder** (five parts, from equipment costing to Monte Carlo analysis):  
+https://github.com/pbtamarona/OpenPyTEA/tree/main/walkthrough
 
 **For the full documentation of the package, visit the ReadTheDocs page:**  
 https://openpytea.readthedocs.io
@@ -62,16 +62,34 @@ Lunch, snacks, coffee, and drinks will be provided!
 pip install openpytea
 ```
 
+If you work in Jupyter notebooks or want to run the walkthrough and example notebooks, we recommend installing with the `ipython` extra:
+
+```bash
+pip install "openpytea[ipython]"
+```
+
+The difference:
+
+- `pip install openpytea` installs the core package. This is enough for Python scripts and the command-line interface.
+- `pip install "openpytea[ipython]"` also installs `ipython` and `ipywidgets`, which OpenPyTEA uses to show a live progress bar in notebooks during Monte Carlo runs. Without them, the progress bar falls back to plain text and Jupyter shows a warning. Jupyter itself is not included; install it separately if needed (e.g. `pip install jupyter`).
+
 ### 2. **Install from GitHub (development version)**
 
 ```bash
 pip install git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
+or, with the `ipython` extra for notebooks:
+
+```bash
+pip install "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"
+```
+
 or with `uv`:
 
 ```bash
 uv add git+https://github.com/pbtamarona/OpenPyTEA
+uv add "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"  # with notebook extras
 ```
 
 **OpenPyTEA** requires **Python ≥ 3.10**.  
@@ -97,7 +115,7 @@ src/openpytea/
 ├── 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
+walkthrough/                # Walkthrough of the package, split into five notebooks (part_1 ... part_5)
 pyproject.toml
 README.md
 ```
@@ -236,7 +254,7 @@ cash_flow = cash_flow_data(ammonia_plant)
 fig, ax = plot_cash_flow(cash_flow)
 ```
 
-As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`/`payback_time`) for use outside the plot, e.g. in reports.
+As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`) for use outside the plot, e.g. in reports.
 
 ### 5. **Sensitivity and uncertainty analysis**
 

{openpytea-3.0.0 → openpytea-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "OpenPyTEA"
-version = "3.0.0"
+version = "3.1.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"

{openpytea-3.0.0 → openpytea-3.1.0/src/OpenPyTEA.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenPyTEA
-Version: 3.0.0
+Version: 3.1.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
@@ -34,8 +34,8 @@ Beyond its functionality, **OpenPyTEA is designed as a community-driven TEA plat
 
 Whether used for early-stage process design, technology screening, or teaching, **OpenPyTEA** makes TEA more accessible, consistent, and aligned with FAIR research principles (Findable, Accessible, Interoperable, and Reusable).
 
-**For a full walkthrough of the features and usage of OpenPyTEA, refer to the `walkthrough.ipynb` notebook**:  
-https://github.com/pbtamarona/OpenPyTEA/blob/main/walkthrough.ipynb
+**For a full walkthrough of the features and usage of OpenPyTEA, refer to the notebooks in the `walkthrough` folder** (five parts, from equipment costing to Monte Carlo analysis):  
+https://github.com/pbtamarona/OpenPyTEA/tree/main/walkthrough
 
 **For the full documentation of the package, visit the ReadTheDocs page:**  
 https://openpytea.readthedocs.io
@@ -86,16 +86,34 @@ Lunch, snacks, coffee, and drinks will be provided!
 pip install openpytea
 ```
 
+If you work in Jupyter notebooks or want to run the walkthrough and example notebooks, we recommend installing with the `ipython` extra:
+
+```bash
+pip install "openpytea[ipython]"
+```
+
+The difference:
+
+- `pip install openpytea` installs the core package. This is enough for Python scripts and the command-line interface.
+- `pip install "openpytea[ipython]"` also installs `ipython` and `ipywidgets`, which OpenPyTEA uses to show a live progress bar in notebooks during Monte Carlo runs. Without them, the progress bar falls back to plain text and Jupyter shows a warning. Jupyter itself is not included; install it separately if needed (e.g. `pip install jupyter`).
+
 ### 2. **Install from GitHub (development version)**
 
 ```bash
 pip install git+https://github.com/pbtamarona/OpenPyTEA
 ```
 
+or, with the `ipython` extra for notebooks:
+
+```bash
+pip install "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"
+```
+
 or with `uv`:
 
 ```bash
 uv add git+https://github.com/pbtamarona/OpenPyTEA
+uv add "openpytea[ipython] @ git+https://github.com/pbtamarona/OpenPyTEA"  # with notebook extras
 ```
 
 **OpenPyTEA** requires **Python ≥ 3.10**.  
@@ -121,7 +139,7 @@ src/openpytea/
 ├── 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
+walkthrough/                # Walkthrough of the package, split into five notebooks (part_1 ... part_5)
 pyproject.toml
 README.md
 ```
@@ -260,7 +278,7 @@ cash_flow = cash_flow_data(ammonia_plant)
 fig, ax = plot_cash_flow(cash_flow)
 ```
 
-As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`/`payback_time`) for use outside the plot, e.g. in reports.
+As with the cost breakdowns, passing a **list of plants** overlays their cumulative cash flow curves — each with its own shaded debt region and break-even line — for direct comparison. The returned dictionary also carries the underlying figures (`max_investment`, `max_investment_year`, `breakeven_year`) for use outside the plot, e.g. in reports.
 
 ### 5. **Sensitivity and uncertainty analysis**
 

{openpytea-3.0.0 → openpytea-3.1.0}/src/openpytea/__init__.py

@@ -3,6 +3,8 @@ assessment of chemical process plants and energy systems with
 economic sensitivity and uncertainty evaluation.
 """
 
+from importlib.metadata import version
+
 from .plant import Plant
 from .equipment import Equipment, CompositeEquipment, inflation_adjustment
 from .analysis import (direct_costs_data, fixed_capital_data,
@@ -19,16 +21,9 @@ from .plotting import (plot_stacked_bar, plot_cash_flow,
 from .io import (load_results, load_openpytea_config,
                  run_equipment, run_plant, run_tea, run_openpytea)
 
-__version__ = "3.0.0"
+__version__ = version("openpytea")
 __author__ = "Panji B. Tamarona"
-__email__ = "P.B.Tamarona@tudelft.nl"
 __license__ = "MIT"
-__description__ = (
-    "OpenPyTEA: An open-source python toolkit for techno-economic"
-    " assessment of chemical process plants and energy systems with"
-    " economic sensitivity and uncertainty evaluation"
-)
-__url__ = "https://github.com/PBTamarona/OpenPyTEA"
 
 __all__ = [
     "Plant",