Metadata-Version: 2.3
Name: thermopt
Version: 0.0.5
Summary: A Python tool for the analysis and optimization of thermodynamic cycles.
License: MIT
Author: Roberto Agromayor
Requires-Python: >=3.10,<4.0
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
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: CoolProp (>=6.6.0,<7.0.0)
Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
Requires-Dist: cycler (>=0.12.1,<0.13.0)
Requires-Dist: imageio[ffmpeg] (>=2.37.0,<3.0.0)
Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: scipy (>=1.13.1,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://github.com/turbo-sim/thermopt
Project-URL: Repository, https://github.com/turbo-sim/thermopt
Description-Content-Type: text/markdown


# ThermoOpt

``ThermoOpt`` is a python package for the modeling and optimization of thermodynamic cycles.


## Quick installation guide (from Git repository)

This guide will walk you through installing ``Thermopt`` using ``Poetry``, which manages dependencies and virtual environments efficiently.

### 1. Install Poetry

If you haven't installed Poetry yet, follow the official guide:  
[Poetry Installation](https://python-poetry.org/docs/#installation)


Verify the installation:
```sh
poetry --version
```

### 2. Clone the Repository

If you haven't cloned the ``ThermOpt`` repository yet, do so:
```sh
git clone https://github.com/turbo-sim/thermopt
cd thermopt
```

### 3. Create a Virtual Environment and Install Dependencies

Poetry will automatically create a virtual environment and install all dependencies specified in `pyproject.toml`:
```sh
poetry install
```

### 4. Activate the Virtual Environment

To activate the virtual environment, run:
```sh
poetry shell
```

To deactivate it, simply type:
```sh
exit
```

### 5. Verify the Installation

Run the following command inside the Poetry shell or using `poetry run`:
```sh
poetry run python -c "import thermopt; thermopt.print_package_info()"
```
If successful, this will display the Thermopt banner and package details.

### 6. Installing Additional Packages

To install new dependencies:
```sh
poetry add <package-name>
```

For development dependencies:
```sh
poetry add --dev <package-name>
```

---

