Metadata-Version: 2.4
Name: pvtlib
Version: 1.17.0
Summary: A library containing various tools in the categories of thermodynamics, fluid mechanics, metering etc.
Author-email: Christian Hågenvik <chaagen2013@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/equinor/pvtlib
Project-URL: Documentation, https://equinor.github.io/pvtlib/
Keywords: thermodynamics,fluid-mechanics,metering,aga8
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
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.2
Requires-Dist: scipy>=1.11.4
Requires-Dist: pyaga8>=0.1.18
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Provides-Extra: examples
Requires-Dist: matplotlib; extra == "examples"
Requires-Dist: pandas; extra == "examples"
Requires-Dist: nbconvert; extra == "examples"
Requires-Dist: ipykernel; extra == "examples"
Provides-Extra: docs
Requires-Dist: sphinx>=7.3; extra == "docs"
Requires-Dist: myst-nb>=1.1; extra == "docs"
Requires-Dist: furo>=2024.1.29; extra == "docs"
Dynamic: license-file

<img src="https://raw.githubusercontent.com/equinor/pvtlib/main/images/pvtlib_klab.png" alt="pvtlib logo" width="600"/>

[![PyPI version](https://img.shields.io/pypi/v/pvtlib)](https://pypi.org/project/pvtlib/)
[![Python versions](https://img.shields.io/pypi/pyversions/pvtlib)](https://pypi.org/project/pvtlib/)
[![Tests](https://github.com/equinor/pvtlib/actions/workflows/tests.yml/badge.svg)](https://github.com/equinor/pvtlib/actions/workflows/tests.yml)
[![Documentation](https://github.com/equinor/pvtlib/actions/workflows/docs.yml/badge.svg)](https://equinor.github.io/pvtlib/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

`pvtlib` is a Python library that provides various tools in the categories of thermodynamics, fluid mechanics, metering and various process equipment. The library includes functions for calculating flow rates, gas properties, and other related calculations.

## Installation

You can install the library using `pip`:

```sh
pip install pvtlib
```

A specific release can be installed by its version, for example `pip install pvtlib==1.16.1`.
`pvtlib.__version__` reports the installed version. Releases are listed at
https://github.com/equinor/pvtlib/releases; see [releasing](docs/releasing.md) for how versions are
numbered and made.

## Usage

Here is an example of how to use the library:

```py
from pvtlib.metering import differential_pressure_flowmeters

# Example usage of the calculate_flow_venturi function
result = differential_pressure_flowmeters.calculate_flow_venturi(D=0.1, d=0.05, dP=200, rho1=1000)
print(result)
```

More examples are provided in the examples folder: https://github.com/equinor/pvtlib/tree/main/examples

The documentation, with the examples and the API reference, is at https://equinor.github.io/pvtlib/.

## Features

- **Thermodynamics**: Thermodynamic functions
- **Fluid Mechanics**: Fluid mechanic functions
- **Metering**: Metering functions
  - Ultrasonic wet-gas over-reading correction using van Putten et al. (NSFMW, 2015),
    implementing the simplified model (Equations 29-30), not the full physical model
    (Equation 28). See the [example notebook](examples/13%20Ultrasonic%20Wetgas%20Van%20Putten/README.md).
- **aga8**: Equations for calculating gas properties (GERG-2008 and DETAIL) using the Rust port (https://crates.io/crates/aga8) of NIST's AGA8 code (https://github.com/usnistgov/AGA8). **Note: AGA8 is only valid for single-phase gas conditions. It does not check for phase state and will produce erroneous results in the two-phase or liquid region.**
- **Unit converters**: Functions to convert between different units of measure
- **Equipment**:
  - **Compressors**: Compressor performance calculations (e.g. polytropic exponent, polytropic head and efficiency)
  - **Separators**: Separator/scrubber sizing functions (e.g. K-value calculations)
  - **Valves**: Valve flow calculations (e.g. Kv/Cv flow factor)


### Handling of invalid input
This library is used for analyzing large amounts of data, as well as in live applications. In these applications it is desired that the functions return "nan" (using numpy nan) when invalid input are provided, or in case of certain errors (such as "divide by zero" errors). 

## Running Tests

Tests are located in the `tests/` folder and use [pytest](https://docs.pytest.org/). Install pvtlib from a git clone of the repository (with its tags, as the version is read from them) with the `test` extra before running:

```sh
pip install -e .[test]
```

Then run the tests from the project root:

```sh
pytest
```

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/equinor/pvtlib/blob/main/LICENSE) file for details.

## Contact

For any questions or suggestions, feel free to open an issue or contact the author at chaagen2013@gmail.com.
