EvenSol / neqsimpython

NeqSim Python interface. Python toolboxes. Examples of use are given in jupyter workbooks.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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-xxx.whl

Getting Started

See the NeqSim Python Wiki for how to use NeqSim Python via Python or in Jupyter notebooks.

Prerequisites

A Java run time environment (Java JRE) needs to be installed. The Python package py4j is used to connect Python and Java. The needed Python packages are listed in the NeqSim Python dependencies page.

Initial setup

The NeqSim Python package is downloaded by 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.

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.

NeqSim Slack collaboration hub

Discussions related to NeqSim development and use is done using Slack for NeqSim. Use the invitation link to join the group.

NeqSim Slack collaboration hub

Discussions related to NeqSim development and use is done using Slack for NeqSim. Use the invitation link to join the group.

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 Python interface. Python toolboxes. Examples of use are given in jupyter workbooks.

License:Apache License 2.0


Languages

Language:Jupyter Notebook 93.2%Language:Python 6.7%Language:Batchfile 0.0%