Home

The Water Resources Evaluation Service

The Water Resources Evaluation Service (WRES) is a comprehensive service for evaluating the quality of existing and emerging OWP and RFC models and forecast systems.

What are the software requirements for executing the WRES?

Use of the WRES requires Java JDK 17+.

How do I declare an evaluation?

Evaluation instructions are declared through a YAML file. See Declaration Language for instructions on how to declare an evaluation.

How do I execute an evaluation?

Executing an evaluation requires either (1) obtaining the latest distribution .zip file, unpackaging it, and running a script; or (2) cloning the repository, building and installing the software locally, and running a script.

How do I obtain the latest distribution .zip and install the software locally?

• Navigate to the releases page: https://github.com/NOAA-OWP/wres/releases

• Download the latest core zip from the assets of the most recent deploy

  • Should look like wres-DATE-VERSION.zip

How do I build and install the software locally?

To build WRES for local use, clone the repository, and run the following commands in your preferred terminal

./gradlew check javadoc installDist

This is similar to unzipping the production distribution zip locally. The WRES software will be built and installed in build/install/wres directory, as if unzipped.

How do I execute the WRES software?

Change directory to either the unzipped or built-and-installed wres@ directory:

cd build/install/wres/

To execute a project you can run the following command:

bin/wres execute yourProject.yml

Example Evaluation

If the software was cloned, built, and installed locally, running the following command will execute a test project using the executable you have created (this running successfully is reliant on being in the wres/build/install/wres directory)

bin/wres execute ../../../systests/testScenario/evaluation.yml