Use the published Maven artifact for applications. Clone the repository when you want to run the complete tests, change NeqSim, or contribute documentation and code.

Install the released library

Add the current project version to a Maven build:

<dependency>
  <groupId>com.equinor.neqsim</groupId>
  <artifactId>neqsim</artifactId>
  <version>3.18.0</version>
</dependency>

Use Maven Central to inspect published versions and GitHub Releases for release notes and downloadable assets. Older predecessor repositories are not authoritative.

Build the current source

A Maven wrapper is included, so a separate Maven installation is not required:

git clone https://github.com/equinor/neqsim.git
cd neqsim
./mvnw install

On Windows, run mvnw.cmd install. NeqSim source remains compatible with Java 8; the continuous integration matrix also exercises newer supported JDKs. See the developer setup guide for platform-specific prerequisites, formatting, tests, and troubleshooting.

Choose a starting point

Goal Maintained documentation
Understand the documentation structure Documentation landing page
Run a first Java calculation Java getting-started guide
Browse the package-level map Package documentation
Find a specific topic Reference manual index
Follow the wiki learning path Wiki getting-started guide
Review common questions Frequently asked questions
Explore worked examples Usage examples

Engineering topic map

Topic Guide
Thermodynamic models and flashes Thermodynamics guide
Process flowsheets and equipment Process simulation guide
Pipelines and multiphase flow Pipeline documentation index
PVT experiments and workflows PVT simulation workflows
Design cases and deliverables Engineering documentation

Authoritative project resources

Repository Java tests are valuable usage evidence, but user-facing examples should also be checked against the current public API and executed before publication.