This repository contains configurations, templates, and some code used for running initial benchmarks of four different NextGen Formulations.

We will assume a valid ngen build exists, see build for details on the model engine and formulation builds used for this effort.

Activate the ngen venv, with the vairous python dependencies noted in the build notes.

source <path_to_ngen_venv>/bin/activate

All required data for the benchmarking can currently be found on the s3://ngen-bm bucket. These can also be extracted from an archive for use, provided the relevant inputs described below are available.

Key inputs are

This directory contains NextGen Hydrofabric v2.1.1 geopackage domains for each of the benchmark locations.

@snowhydrology TODO

The forcing data used to run the models, must contain at least the calibration and validation time periods. This work used AORC data with a simple weighted average downsampling to each hydrofabric divide. The netcdf ngen supported format was used.

@ajkhattak TODO

@aaraney TODO

This reposotiry contains realization, ngen-cal, and t-route templates which are used to produce the calibration results.

Copy the formulation realization template to calibrate, e.g.

realizations/nom_cfe_nash_s.json to your working directory, and modify the following template strings

• CONFIG_DIR : the directory which bmi configuration files are stored.
• HYDROFAB_INPUT : the hydrofabric geopackage name prefix, e.g. hf_211_<location>

Each of these paths may need adjusted in each realization based on your environment and setup.

Next you need to pick the ngen-cal configuration template based on the formulation to run and copy it to your working directory, e.g.

templates/nom_cfe_nash_s_template.yaml

In this template file, you will need to modify the following template strings

• WORKDIR_INPUT : The name of a working directory to hold the calibration results in, this MUST be an absolute path!
• NGEN_INPUT : Absolute path to the ngen model engine binary
• REALIZATION_INPUT : Path to the realization setup in the previous step
• GPKG_INPUT: Hydrofabric geopackage (needs to be the same location configured in the realization step)
• EVAL_FEAT_INPUT: The hydrofabric identifier of the waterbody coinciding with the downstream gage where evaluation will occur, e.g. wb-012345. Note this information is in the basin_info data for the benchmarking excercise.

Finally, copy both templates/routing_template.yaml and templates/routing_validation_template.yaml to your working directory and edit the following template string in each file

• GPKG_INPUT : The hydrofabric geopackage input for the location

With all the files created in the current working dir and their template strings updated accordingly, simply run ngen-cal

python -m ngen.cal <config.yaml>

where <config.yaml> is the ngen-cal config created from the formulation template, e.g. cfe_nash_s_template.yaml