Skip to content

Getting started with NeqSim and Github

Jump to bottom Edit New page
Even Solbraa edited this page Aug 20, 2025 · 14 revisions

The NeqSim library as a jar files can be downloaded from the NeqSim release pages. A shaded library is distributed including all dependent libraries used by NeqSim. Use of NeqSim in a Java program is done by adding NeqSim.jar to the classpath.

Building NeqSim from source is done by cloning the project to a local directory on the developer computer. Building the code is done using JDK8+. NeqSim uses a number of libraries (jar files) for various calculations. These libraries must be available as part of the compilation process. The required libraries are listed in the pom.xml file. NeqSim can be built using the Maven build system (https://maven.apache.org/). All NeqSim build dependencies are given in the pom.xml file.

An interactive demonstration of how to get started as a NeqSim developer is presented in this NeqSim Colab demo.

Also see NeqSim JavaDoc.

And also see the Java tests where a lot of the functionality is demosntrated.

NeqSim - a Java library for oil and gas process calculations

🚀 Getting Started

Wiki:

  1. Getting started with NeqSim and GitHub
  2. Getting started as a NeqSim developer
  3. The NeqSim parameter database

Docs:

🧪 Thermodynamics

Wiki: 4. Setting up a fluid and flash calculations 5. Select EOS and mixing rule 6. Flash and phase envelope calculations 7. Thermodynamic and physical properties

Docs - Fundamentals:

Docs - Equations of State:

Docs - Flash & Operations:

🛢️ Fluid Characterization

Wiki: 8. Oil Characterization 9. Aqueous fluids 10. Electrolytes

Docs:

🔬 Physical Properties

Docs - Overview:

Docs - Specific Models:

⚙️ Process Simulation

Wiki: 11. Process Calculations

Docs - Fundamentals:

Docs - Advanced Process Logic:

🔧 Equipment Models

Compressors & Turbomachinery:

Pumps:

Separation:

Heat Transfer:

Valves & Flow Control:

Tanks & Storage:

Streams & Mixers:

Reactors:

Wells:

Energy & Special Equipment:

🌊 Pipeline & Multiphase Flow

Docs - Overview:

Docs - Single Phase Flow:

Docs - Two-Phase & Multiphase:

Docs - Pressure Drop & Friction:

Docs - Heat & Mass Transfer:

Docs - Transient Flow:

📊 PVT & Black Oil

Docs - PVT Simulation:

Docs - Black Oil:

Docs - Gas Quality:

🧊 Flow Assurance

Docs - Asphaltene:

⚡ Dynamic & Transient Simulation

Wiki: 18. Dynamic process simulations

Docs:

🛡️ Safety & Relief Systems

Docs - Overview:

Docs - Relief & Blowdown:

Docs - HIPPS:

Docs - Safety Systems:

📏 Standards & Quality

Docs:

📈 Statistics & Parameter Fitting

Docs:

🔌 Integration & APIs

Wiki: 15. How to make a NeqSim API

Docs - Overview:

Docs - AI/ML:

Docs - MPC & Control:

Docs - Risk & Safety:

🏭 Optimization & Planning

Docs:

🛠️ Extending NeqSim

Wiki: 12. Adding a thermodynamic model 13. Adding a viscosity model 14. Adding a unit operation

Docs:

⚡ Performance & Deployment

Wiki: 16. Create native image using GraalVM 17. Profiling calculations

📚 Examples & Tutorials

Jupyter Notebooks:

Java Examples:

External:

🔗 Quick Links

Clone this wiki locally