ecoana 0.0.1__tar.gz

ecoana-0.0.1/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Haeun Choi, Kosan Roh, Laboratory of Sustainable Process Engineering (LSPE), Chungnam National University
+
+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.

ecoana-0.0.1/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: ecoana
+Version: 0.0.1
+Summary: ECO-ANA: Techno-Economic Analysis Tool for Chemical Processes
+Author-email: Haeun Choi <nolaaa@o.cnu.ac.kr>
+Project-URL: Repository, https://github.com/LSPE-CNU/ECO-ANA_Techno-Economic-Analysis-Tool-for-Chemical-Processes
+Keywords: chemical engineering,process systems engineering,process design,equipment cost estimation,capital cost estimation,process economics,Techno-economic analysis,cost engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.21
+Dynamic: license-file
+
+**[ECO-ANA: Techno-Economic Analysis Tool for Chemical Processes]**
+---
+**SUMMARY**
+---
+<img width="4816" height="1256" alt="Frame 21 (1)" src="https://github.com/user-attachments/assets/49512815-1450-48d7-b29f-f2950aa8fdea" />
+
+**ECO-ANA**(Process **Eco**nomic-**Ana**lyzer) is designed to support early-stage techno-economic analysis (TEA) of chemical processes accounting for cost estimation model uncertainty.  
+This was developed by **LSPE**, the *Laboratory for Sustainable Process Engineering* from Chungnam national university.  
+LSPE@CNU: https://sites.google.com/view/rohgroup
+
+**INSTALLATION**
+---
+Install the package from PyPI:
+```
+pip install ecoana
+```
+
+**MODULES**
+---
+1. `ecoana.eqpcomo()`  
+     `eqpcomo()` is a Python module for chemical process equipment cost estimation.
+     This module provides a unified interface to estimate equipment purchase costs using several well-known correlations from chemical engineering literature.
+     Each model contains equipment-specific correlations, capacity ranges, and material factors based on the original literature sources.  
+       
+     The library currently implements equipment cost estimation models from:  
+     > *Turton model*: Richard A. Turton (2018), “Analysis, Synthesis, and Design of Chemical processes” (5th ed.)  
+     > *Seider model*: Warren D. Seider (2016), “Product and Process Design Principles: Synthesis, Analysis and Evaluation” (4th ed.)  
+     > *Smith model*: Robin Smith (2016), “Chemical Process Design and Integration” (2nd ed.)  
+     > *Peters model*: Max. S. Peters (2003), “Plant Design and Economics for Chemical Engineers” (5th ed.)  
+     > *Towler model*: Gavin Towler (2007), “Chemical Engineering Design –Principles, Practice and Economics of plant” (1st ed.)  
+     > *Guthrie model*: L. T. Biegler (1997) "Systematic Methods of Chemical Process Design" (1st ed.)
+ <br />
+ 
+   - Function Interface    <br />
+     Main features:
+     ```
+     eqpcomo(model="model name", equipment="equipment name", eqptype="equipment type name", par_1=par_1_value, par_2=par_2_value,...)
+     ```
+     <br />
+     Table of parameters to `eqpcomo()` function:
+     
+     | Parameter     | Description                                                                        |
+     | ------------- | ---------------------------------------------------------------------------------- |
+     | model         | Cost estimation model (`Turton`, `Seider`, `Smith`, `Towler`, `Peters`, `Guthrie`) |
+     | equipment     | Equipment name                                                                     |
+     | eqptype       | Equipment type                                                                     |
+     | material      | Construction material                                                              |
+     | T_K           | Design temperature (K)                                                             |
+     | P_bar         | Design pressure (bar)                                                              |
+     | vol_cum       | Volume (m³)                                                                        |
+     | area_sqm      | Heat transfer area (m²)                                                            |
+     | power_kW      | Equipment power (kW)                                                               |
+     | massflow_kgph | Mass flow rate (kg/h)                                                              |
+     | volflow_cumph | Volumetric flow rate (m³/h)                                                        |
+     | diameter_m    | Diameter (m)                                                                       |
+     | height_m      | Height (m)                                                                         |
+     | thickness_m   | Wall thickness (m)                                                                 |
+        <br />
+        
+ - Basic Usage <br />
+     Example: Estimating the cost of a centrifugal compressor using the Smith model.
+     ```
+     from ecoana import eqpcomo
+     
+     cost = eqpcomo(
+          model="Smith",
+          equipment="Compressor",
+          eqptype="Centrifugal",
+          T_K=400,
+          P_bar=10,
+          material='Carbon steel',
+          power_kW=1000
+     )
+     print(cost)
+     ```
+     Output: The `eqpcomo()` returns a tuple containing two values.
+     ```
+     (212390.5, '2000 year basis')
+     ```
+     Each equipment cost estimation models are based on correlations derived from price data for different years.  <br />
+   Therefore, the function returns the basis year together with the cost estimate so that users can adjust the cost using an appropriate **Capital Cost Index (e.g., CEPCI)** if needed.  <br />
+   <br />
+   
+ - Error Messages   <br />
+     The required parameters for function can be differ depending on selected cost estimation model or equipment type.   <br />    
+     Therefore, the `eqpcomo()` includes built-in input validation and guidance through error messages.  <br />
+       <br /> 
+     If required parameters are missing or invalid, the function returns a error message indicating:  <br />
+     - which input parameter is missing  
+     - whether the selected model or equipment type is unsupported  
+     - the list of available options for the given model
+      <br />
+     Example 1: <br />
+     If the essential parameters required for cost estimation is not input into the function,
+     
+     ```
+     eqpcomo(model="Turton", equipment="Vaporizer")
+     ```  
+     ```
+     Error: Missing required input variables for the selected model and equipment. Missing variables: ['eqptype', 'vol_cum', 'P_bar', 'material']
+     ```
+     
+     <br />
+     Example 2:   <br />
+     If the model does not support the equipment cost estimation formula for the equipment specifiaction (e.g., material, equipment, eqptype) input by the user.
+   
+     ```
+     eqpcomo(model="Turton", equipment="Membrane")
+     ```  
+     ```
+     Error: The selected equipment 'Membrane' is not available in the equipment cost estimation model. Available equipment options: ['Blender', 'Centrifuge', 'Compressor', 'Conveyor', 'Crystallizer-batch evaporative', 'Dryer', 'Dust collector', 'Evaporator', 'Fans', 'Furnace', 'Filters', 'Mixer', 'Heater', 'Packing', 'Vessel/Tower', 'Pumps', 'Reactor', 'Storage tank', 'Screens', 'Trays', 'Turbines', 'Vaporizer', 'Heat exchanger (shell and tube)', 'Heat exchanger (others)']
+     ```
+     <br />
+- Automatic Parameter Estimation  <br />
+The `eqpcomo()` can automatically estimate some parameters when they are not explicitly provided, as long as enough related equipment data is available.<br />
+
+| Estimated parameter | Description           | Required input parameters for estimation     | Applied condition                                                  |
+| ------------------- | --------------------- | -------------------------------------------- | ------------------------------------------------------------------ |
+| `vol_cum`           | Vessel volume         | `diameter_m`, `height_m`                     | When `equipment="Vessel/Tower"` and `vol_cum` is not provided      |
+| `thickness_m`       | Vessel wall thickness | `diameter_m`, `P_bar`, `T_K`, `material`     | When `equipment="Vessel/Tower"` and `thickness_m` is not provided  |
+| `pumphead_m`        | Pump head             | `power_kW`, `volflow_cumph`, `massflow_kgph` | Available through helper logic when pump head needs to be inferred |
+
+<br />
+
+**AUTHOR**
+---
+Haeun Choi  
+E-mail: nolaaa@o.cnu.ac.kr
+
+**ACKNOWLEDGEMENT**
+---
+This work is supported by the Development of next-generation biorefinery platform technologies for leading bio-based chemicals industry project (2022M3J5A1056072), by Development of platform technologies of microbial cell factories for the next-generation biorefineries project (2022M3J5A1056117), and by the Education and Research Center for Eco-Friendly Next-Generation Batteries (RS-2024-00447869) from National Research Foundation supported by the Korean Ministry of Science and ICT.
+

ecoana-0.0.1/README.md

@@ -0,0 +1,133 @@
+**[ECO-ANA: Techno-Economic Analysis Tool for Chemical Processes]**
+---
+**SUMMARY**
+---
+<img width="4816" height="1256" alt="Frame 21 (1)" src="https://github.com/user-attachments/assets/49512815-1450-48d7-b29f-f2950aa8fdea" />
+
+**ECO-ANA**(Process **Eco**nomic-**Ana**lyzer) is designed to support early-stage techno-economic analysis (TEA) of chemical processes accounting for cost estimation model uncertainty.  
+This was developed by **LSPE**, the *Laboratory for Sustainable Process Engineering* from Chungnam national university.  
+LSPE@CNU: https://sites.google.com/view/rohgroup
+
+**INSTALLATION**
+---
+Install the package from PyPI:
+```
+pip install ecoana
+```
+
+**MODULES**
+---
+1. `ecoana.eqpcomo()`  
+     `eqpcomo()` is a Python module for chemical process equipment cost estimation.
+     This module provides a unified interface to estimate equipment purchase costs using several well-known correlations from chemical engineering literature.
+     Each model contains equipment-specific correlations, capacity ranges, and material factors based on the original literature sources.  
+       
+     The library currently implements equipment cost estimation models from:  
+     > *Turton model*: Richard A. Turton (2018), “Analysis, Synthesis, and Design of Chemical processes” (5th ed.)  
+     > *Seider model*: Warren D. Seider (2016), “Product and Process Design Principles: Synthesis, Analysis and Evaluation” (4th ed.)  
+     > *Smith model*: Robin Smith (2016), “Chemical Process Design and Integration” (2nd ed.)  
+     > *Peters model*: Max. S. Peters (2003), “Plant Design and Economics for Chemical Engineers” (5th ed.)  
+     > *Towler model*: Gavin Towler (2007), “Chemical Engineering Design –Principles, Practice and Economics of plant” (1st ed.)  
+     > *Guthrie model*: L. T. Biegler (1997) "Systematic Methods of Chemical Process Design" (1st ed.)
+ <br />
+ 
+   - Function Interface    <br />
+     Main features:
+     ```
+     eqpcomo(model="model name", equipment="equipment name", eqptype="equipment type name", par_1=par_1_value, par_2=par_2_value,...)
+     ```
+     <br />
+     Table of parameters to `eqpcomo()` function:
+     
+     | Parameter     | Description                                                                        |
+     | ------------- | ---------------------------------------------------------------------------------- |
+     | model         | Cost estimation model (`Turton`, `Seider`, `Smith`, `Towler`, `Peters`, `Guthrie`) |
+     | equipment     | Equipment name                                                                     |
+     | eqptype       | Equipment type                                                                     |
+     | material      | Construction material                                                              |
+     | T_K           | Design temperature (K)                                                             |
+     | P_bar         | Design pressure (bar)                                                              |
+     | vol_cum       | Volume (m³)                                                                        |
+     | area_sqm      | Heat transfer area (m²)                                                            |
+     | power_kW      | Equipment power (kW)                                                               |
+     | massflow_kgph | Mass flow rate (kg/h)                                                              |
+     | volflow_cumph | Volumetric flow rate (m³/h)                                                        |
+     | diameter_m    | Diameter (m)                                                                       |
+     | height_m      | Height (m)                                                                         |
+     | thickness_m   | Wall thickness (m)                                                                 |
+        <br />
+        
+ - Basic Usage <br />
+     Example: Estimating the cost of a centrifugal compressor using the Smith model.
+     ```
+     from ecoana import eqpcomo
+     
+     cost = eqpcomo(
+          model="Smith",
+          equipment="Compressor",
+          eqptype="Centrifugal",
+          T_K=400,
+          P_bar=10,
+          material='Carbon steel',
+          power_kW=1000
+     )
+     print(cost)
+     ```
+     Output: The `eqpcomo()` returns a tuple containing two values.
+     ```
+     (212390.5, '2000 year basis')
+     ```
+     Each equipment cost estimation models are based on correlations derived from price data for different years.  <br />
+   Therefore, the function returns the basis year together with the cost estimate so that users can adjust the cost using an appropriate **Capital Cost Index (e.g., CEPCI)** if needed.  <br />
+   <br />
+   
+ - Error Messages   <br />
+     The required parameters for function can be differ depending on selected cost estimation model or equipment type.   <br />    
+     Therefore, the `eqpcomo()` includes built-in input validation and guidance through error messages.  <br />
+       <br /> 
+     If required parameters are missing or invalid, the function returns a error message indicating:  <br />
+     - which input parameter is missing  
+     - whether the selected model or equipment type is unsupported  
+     - the list of available options for the given model
+      <br />
+     Example 1: <br />
+     If the essential parameters required for cost estimation is not input into the function,
+     
+     ```
+     eqpcomo(model="Turton", equipment="Vaporizer")
+     ```  
+     ```
+     Error: Missing required input variables for the selected model and equipment. Missing variables: ['eqptype', 'vol_cum', 'P_bar', 'material']
+     ```
+     
+     <br />
+     Example 2:   <br />
+     If the model does not support the equipment cost estimation formula for the equipment specifiaction (e.g., material, equipment, eqptype) input by the user.
+   
+     ```
+     eqpcomo(model="Turton", equipment="Membrane")
+     ```  
+     ```
+     Error: The selected equipment 'Membrane' is not available in the equipment cost estimation model. Available equipment options: ['Blender', 'Centrifuge', 'Compressor', 'Conveyor', 'Crystallizer-batch evaporative', 'Dryer', 'Dust collector', 'Evaporator', 'Fans', 'Furnace', 'Filters', 'Mixer', 'Heater', 'Packing', 'Vessel/Tower', 'Pumps', 'Reactor', 'Storage tank', 'Screens', 'Trays', 'Turbines', 'Vaporizer', 'Heat exchanger (shell and tube)', 'Heat exchanger (others)']
+     ```
+     <br />
+- Automatic Parameter Estimation  <br />
+The `eqpcomo()` can automatically estimate some parameters when they are not explicitly provided, as long as enough related equipment data is available.<br />
+
+| Estimated parameter | Description           | Required input parameters for estimation     | Applied condition                                                  |
+| ------------------- | --------------------- | -------------------------------------------- | ------------------------------------------------------------------ |
+| `vol_cum`           | Vessel volume         | `diameter_m`, `height_m`                     | When `equipment="Vessel/Tower"` and `vol_cum` is not provided      |
+| `thickness_m`       | Vessel wall thickness | `diameter_m`, `P_bar`, `T_K`, `material`     | When `equipment="Vessel/Tower"` and `thickness_m` is not provided  |
+| `pumphead_m`        | Pump head             | `power_kW`, `volflow_cumph`, `massflow_kgph` | Available through helper logic when pump head needs to be inferred |
+
+<br />
+
+**AUTHOR**
+---
+Haeun Choi  
+E-mail: nolaaa@o.cnu.ac.kr
+
+**ACKNOWLEDGEMENT**
+---
+This work is supported by the Development of next-generation biorefinery platform technologies for leading bio-based chemicals industry project (2022M3J5A1056072), by Development of platform technologies of microbial cell factories for the next-generation biorefineries project (2022M3J5A1056117), and by the Education and Research Center for Eco-Friendly Next-Generation Batteries (RS-2024-00447869) from National Research Foundation supported by the Korean Ministry of Science and ICT.
+

ecoana-0.0.1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ecoana"
+version = "0.0.1"
+description = 'ECO-ANA: Techno-Economic Analysis Tool for Chemical Processes'
+readme = "README.md"
+requires-python = ">=3.9"
+
+authors = [
+    {name = "Haeun Choi", email = "nolaaa@o.cnu.ac.kr"}
+]
+
+keywords = [
+    "chemical engineering",
+     "process systems engineering",
+     "process design",
+     "equipment cost estimation",
+     "capital cost estimation",
+     "process economics",
+     "Techno-economic analysis",
+     "cost engineering"
+]
+
+
+dependencies = [
+    "numpy>=1.21"
+]
+
+[project.urls]
+Repository = 'https://github.com/LSPE-CNU/ECO-ANA_Techno-Economic-Analysis-Tool-for-Chemical-Processes'
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

ecoana-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+