Get up and running with the NGIAB calibration workshop in minutes. This guide provides the essential steps to run your first calibration using pre-prepared data.

This workshop requires Docker and UV.

📋 Need installation help? See the Pre-Workshop Checklist for detailed setup instructions.

ssh -L 5906:localhost:5906 exouser@<ip address> #000.000.000.000   

• Quick caveat! If you do not have firefox installed, just run the following command:

sudo apt-get update && sudo apt-get install firefox --yes

On Jetstream Virtual Machines:

cd /home/exouser/workshop/calibration/

On Other Systems:

# Download and extract the data
wget https://communityhydrofabric.s3.us-east-1.amazonaws.com/example_data/provo-10154200.tar.gz
tar -xzf provo-10154200.tar.gz

# -g selects the gage in the hydrofabric, -i sets the number of iterations
uvx ngiab-cal provo-10154200 -g 10154200 -i 4

This command creates a calibration directory with all necessary configuration files for USGS gauge 10154200 (Provo River).

# Quick calibration with 4 iterations (good for testing)
uvx ngiab-cal provo-10154200 -g 10154200 --run -i 4

# Full calibration with 100 iterations (recommended)
uvx ngiab-cal provo-10154200 -g 10154200 --run -i 100

While calibration is running, you can monitor progress in another terminal:

# Watch the calibration log
tail -f provo-10154200/calibration/Output/Calibration_Run/ngen_*/ngen.log

# Check if calibration is complete
ls provo-10154200/calibration/Output/Calibration_Run/*_Calib_Run_Complete

Once complete, examine the calibration outputs:

# View calibration plots
ls provo-10154200/calibration/Output/Calibration_Run/ngen_*/Plot_Iteration/

# Check final parameters
cat calibration/Output/Calibration_Run/ngen_*/*_params_iteration.csv | tail -n 1

# View calibrated parameters file
cat provo-10154200/config/calibrated_params.json

The calibration process generates several types of output:

• Plots: Located in Plot_Iteration/ showing parameter evolution, hydrographs, and performance metrics
• Parameters: CSV files tracking parameter values through iterations
• Performance: Metrics showing how well the model matches observed data
• Configurations: Updated model configurations with calibrated parameters

• Examine Plots: Look at the hydrograph and parameter plots to understand calibration performance
• Adjust Parameters: Edit provo-10154200/calibration/ngen_cal_conf.yaml to modify calibration settings
• Run Validation: The calibration automatically creates validation configurations
• Apply Results: Use the calibrated parameters in provo-10154200/config/calibrated_params.json for future runs

Having issues? Check the Troubleshooting Guide for solutions to common problems.

For detailed explanations and advanced configurations, see the Step-by-Step Instructions.

Back to Home