Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/equinor/neqsim-python
NeqSim is a library for calculation of fluid behavior, phase equilibrium and process simulation. This project is a Python interface to NeqSim.
https://github.com/equinor/neqsim-python
equation-of-state fluid-dynamics fluid-properties gas-production gas-transport oil-and-gas oil-production process-simulation pvt python thermodynamic-properties thermodynamics
Last synced: 6 days ago
JSON representation
NeqSim is a library for calculation of fluid behavior, phase equilibrium and process simulation. This project is a Python interface to NeqSim.
- Host: GitHub
- URL: https://github.com/equinor/neqsim-python
- Owner: equinor
- License: apache-2.0
- Created: 2019-01-04T09:45:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:10:01.000Z (about 2 months ago)
- Last Synced: 2024-10-30T00:39:50.956Z (about 2 months ago)
- Topics: equation-of-state, fluid-dynamics, fluid-properties, gas-production, gas-transport, oil-and-gas, oil-production, process-simulation, pvt, python, thermodynamic-properties, thermodynamics
- Language: Python
- Homepage: https://equinor.github.io/neqsimhome/
- Size: 1.27 GB
- Stars: 58
- Watchers: 10
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# NeqSim Python
NeqSim Python is part of the [NeqSim project](https://equinor.github.io/neqsimhome/). NeqSim Python is a Python interface to the [NeqSim Java library](https://github.com/equinor/neqsim) for estimation of fluid behavior and process design for oil and gas production. NeqSim Python toolboxes (eg. [thermoTools](https://github.com/equinor/neqsimpython/blob/master/neqsim/thermo/thermoTools.py) and [processTools](https://github.com/equinor/neqsimpython/blob/master/neqsim/process/processTools.py)) are implemented to streamline use of neqsim in Python. Examples of use are given in the [examples folder](https://github.com/equinor/neqsim-python/tree/master/examples).
## Releases
NeqSim Python is distributed as a pip package. Please read the [Prerequisites](#prerequisites).
End-users should install neqsim python with some additional packages by running
```
pip install neqsim
```
## Getting Started
See the [NeqSim Python Wiki](https://github.com/equinor/neqsimpython/wiki) for how to use NeqSim Python via Python or in Jupyter notebooks. Also see [examples of use of NeqSim for Gas Processing in Colab](https://colab.research.google.com/github/EvenSol/NeqSim-Colab/blob/master/notebooks/examples_of_NeqSim_in_Colab.ipynb#scrollTo=kHt6u-utpvYf). Learn and ask questions in [Discussions for use and development of NeqSim](https://github.com/equinor/neqsim/discussions).
### Prerequisites
Java version 8 or higher ([Java JDK](https://adoptium.net/)) needs to be installed. The Python package [JPype](https://github.com/jpype-project/jpype) is used to connect Python and Java. Read the [installation requirements for Jpype](https://jpype.readthedocs.io/en/latest/install.html). Be aware that mixing 64 bit Python with 32 bit Java and vice versa crashes on import of the jpype module. The needed Python packages are listed in the [NeqSim Python dependencies page](https://github.com/equinor/neqsimpython/network/dependencies).
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
## Discussion forum
Questions related to neqsim can be posted in the [github discussion pages](https://github.com/equinor/neqsim/discussions).
## Versioning
NeqSim use [SemVer](https://semver.org/) for versioning.
## Licence
NeqSim is distributed under the [Apache-2.0](https://github.com/equinor/neqsimsource/blob/master/LICENSE) licence.
## Acknowledgments
A number of master and PhD students at NTNU have contributed to development of NeqSim. We greatly acknowledge their contributions.