NGIAB TEEHR Integration

A repository for coupling TEEHR with Nextgen-In-A-Box (NGIAB) simulation output.

Warning: This code is experimental!

The example_guide.sh script demonstrates running a TEEHR evaluation (see scripts/teehr_ngen.py) on NGIAB output.

To build and push the TEEHR image to the AWI CIROH registry
Customize the metrics calculated by TEEHR or any other code related to the workflow:

Create a branch off of main
Make your edits to scripts/teehr_ngen.py and/or scripts/utils.py
Update the Changelog so that your changes can be associated with a tag
Submit and PR and merge
Then checkout main and pull the new changes, and push your tag:
git checkout main
git pull
git tag -a v0.x.x -m \"version 0.x.x\"
git push origin v0.x.x
This will trigger a github action to build and push the image with your tag, and the latest tag, to the AWI CIROH registry.

To build and push locally:

docker build -t awiciroh/ngiab-teehr:<tag name> .
docker push awiciroh/ngiab-teehr:<tag name>
Now you can specify the image tag in the guide.sh script.