Skip to content

NeqSim is a Java library for estimation of fluid behavior and process simulation. This project is a Python interface to NeqSim.

License

Notifications You must be signed in to change notification settings

fannemel/neqsimpython

 
 

Repository files navigation

NeqSim Python

NeqSim Python is part of the NeqSim project. NeqSim Python is a Python interface to the NeqSim Java library for estimation of fluid behavior and process design for oil and gas production. NeqSim Python toolboxes (eg. thermoTools and processTools) are implemented to streamline use of neqsim in Python. Examples of use are given in jupyter workbooks.

Releases

The NeqSim Python package is distributed as a pip package. See the Wiki for instructions on how to use it. Install the package by running

pip install neqsim

Getting Started

See the NeqSim Python 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. Learn and ask questions in Discussions for use and development of NeqSim.

Prerequisites

A Java run time environment (Java JRE) needs to be installed. The Python package JPype is used to connect Python and Java. Read the installation requirements for Jpype. 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.

Initial setup

The NeqSim Python package is installed by downloading/cloning the library to your local computer (alternatively fork it to your private reprository). The following commands are dependent on a local installation of GIT. |pypidownloads| |pypiversion|

git clone https://github.com/equinor/neqsimpython.git
cd neqsimpython
pip install .

Contributing

Please read 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.

Versioning

NeqSim use SemVer for versioning.

Licence

NeqSim is distributed under the Apache-2.0 licence.

Acknowledgments

A number of master and PhD students at NTNU have contributed to development of NeqSim. We greatly acknowledge their contributions.

About

NeqSim is a Java library for estimation of fluid behavior and process simulation. This project is a Python interface to NeqSim.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jupyter Notebook 65.7%
  • Python 34.3%