opm-simulators/jenkins/README.md

# opm-simulators jenkins build scripts:

**build.sh**:
This script will build dependencies, then build opm-simulators and execute its tests.
It also inspects the $ghbPrBuildComment environmental variable and builds
downstreams if requested. It inspects the $ghbPrBuildComment
environmental variable to obtain a pull request to use for the modules.

It is intended for pre-merge builds of pull requests.

To specify a given pull request to use for upstreams and downstreams,
trigger line needs to contain <module-name>=<pull request number>.

To build with downstreams the trigger line needs to contain 'with downstreams'.

**run-spe.sh**:
This script will execute the SPE1, SPE3 and SPE9 cases, then compare against
OPM and Eclipse reference results. It is meant to be executed after a build.
The binary used used is from the build identified by the configuration
environment variable.

**run-norne.sh**:
This script will execute the Norne case, and generate a document with
plots of the results. It is meant to be executed after a build.
The binary used used is from the build identified by the configuration
environment variable.

**run-polymer.sh**:
This script will execute the simple2D polymer case, then compare against
Eclipse reference results. It is meant to be executed after a build.
The binary used used is from the build identified by the configuration
environment variable.