Metadata-Version: 2.1
Name: barotropy
Version: 0.2.14
Summary: A Python tool for barotropic fluid property modeling.
Home-page: https://github.com/turbo-sim/barotropy
License: MIT
Author: Roberto Agromayor
Requires-Python: >=3.10,<3.14
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: gmsh
Provides-Extra: pyfluent
Requires-Dist: PyYAML (>=6.0.2,<7.0.0)
Requires-Dist: ansys-fluent-core (>=0.30.2,<0.31.0) ; extra == "pyfluent"
Requires-Dist: coolpropx (>=0.2.8,<0.3.0)
Requires-Dist: cycler (>=0.12.1,<0.13.0)
Requires-Dist: gmsh (>=4.14.0,<5.0.0) ; extra == "gmsh"
Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
Requires-Dist: numpy (>=2.2.4,<3.0.0)
Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: parse (>=1.20.2,<2.0.0)
Requires-Dist: pexpect (>=4.9.0,<5.0.0)
Requires-Dist: pysolver_view (>=0.6.2,<0.7.0)
Requires-Dist: scipy (>=1.15.2,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://turbo-sim.github.io/barotropy/
Project-URL: Repository, https://github.com/turbo-sim/barotropy
Description-Content-Type: text/markdown

# Barotropy

Enhance your two-phase turbomachinery CFD simulations with **`barotropy`**, a Python package designed to create barotropic fluid property models. The barotropic approximation assumes that fluid properties (e.g., density, viscosity, speed of sound) depend solely on pressure, which is a very accurate assumption for most turbomachinery flows. This simplification reduces computational costs while improving convergence reliability in simulations involving complex fluid property variations, such as supercritical CO₂ compressors or two-phase flows in nozzles and turbines.

📦 **PyPI package**: [https://pypi.org/project/barotropy/](https://pypi.org/project/barotropy/)

📚 **Documentation**: [https://turbo-sim.github.io/barotropy/](https://turbo-sim.github.io/barotropy/) *(under construction)*  

🎓 **Tutorials**: [https://turbo-sim.github.io/barotropy/source/tutorials.html](https://turbo-sim.github.io/barotropy/source/tutorials.html)  
*Step-by-step examples for using the barotropic model in CFD solvers like Ansys Fluent and CFX.*


## Key Features

- **Simplified fluid modeling:** Generate barotropic models to lower computational cost and enhance solver robustness compared to real-gas fluid property tables.  
- **Suited for homogeneous two-phase flows:** Simulate two-phase flows with one or two-components using the Homogeneous Equilibrium Model (HEM) or the Delayed Equilibrium Model (DEM) assumptions..  
- **Seamless integration with commercial CFD solvers:** Easily export barotropic models as simple expressions ready to be copy-pasted into ANSYS Fluent or ANSYS CFX.  


<p align="center">
  <img src="docs/_static/two-phase_turbine.jpg"  width="85%" />
</p>

<p align="center">
  <img src="docs/_static/sCO2_compressor.jpg"  width="85%" />
</p>



## 🚀 User installation (via PyPI)

To begin using `barotropy`, install it via `pip`:

```bash
pip install barotropy
```

After installation, verify that everything is set up correctly by running the following command in your terminal:

```bash
python -c "import barotropy; barotropy.print_package_info()"
```

For detailed information and examples, visit the [documentation page](https://turbo-sim.github.io/barotropy/).



## License
The code in this repository is licensed under the terms of the MIT license. See the [license file](LICENSE.md) for more information.


## Contact Information

The code in this repository was developed by the [Sustainable Thermal Power group](https://thermalpower.dtu.dk/) at [DTU Construct](https://construct.dtu.dk/). Drop us an email at [roagr@dtu.dk](mailto:roagr@dtu.dk) if you have questions about the code or have a bug to report!


