Developer Setup

This document summarizes the basic steps from the NeqSim wiki for setting up a local development environment. For additional details see the Getting started as a NeqSim developer wiki page.

Clone the repository

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

Build the project

NeqSim requires JDK 8 or newer and uses the Maven build system. Use the provided Maven wrapper to build the code:

./mvnw install

(Windows users can run mvnw.cmd.)

Run the test suite

Execute all unit tests with:

./mvnw test

To generate a code coverage report:

./mvnw jacoco:prepare-agent test install jacoco:report

Static analysis

Checkstyle, SpotBugs, and PMD plugins are included in the Maven build and run during the verify phase. Run them locally with:

./mvnw checkstyle:check spotbugs:check pmd:check

The checks do not fail the build by default, but fixing any reported issues is encouraged.