Skip to content

README.md

Latest commit

 

History

History
93 lines (59 loc) · 3.89 KB

README.md

File metadata and controls

93 lines (59 loc) · 3.89 KB
Raw

nwm-fcst-mgr

Description

A program to execute ngen cold start and forecast runs provided a configuration file from validation with nwm-cal-mgr and realization files for the cold start and forecast periods

Installation

Clone nwm-fcst-mgr

git clone -b development --recurse-submodules https://github.com/NOAA-OWP/nwm-fcst-mgr.git

Build the environment

To run the program, one would need an environment for successfully running ngen and its modules (including t-route).

If you already have an environment for running ngen, you can use the same venv and pip install matplotlib if it is not already installed.

Otherwise, follow the following steps to build a new environment (in AWS Ubuntu 22.04 LTS Workspace):

  1. cd [VENV_ROOT]
  2. /usr/bin/python3.11 -m venv venv.ngen
  3. source venv.ngen/bin/activate
  4. pip install --upgrade pip
  5. pip3 install numpy==1.26.4 pandas bmipy netcdf4==1.6.3 joblib toolz Cython geopandas pyarrow matplotlib deprecated
  6. cd [NGEN_ROOT]/ngen/extern/t-route/
  7. pip install -r requirements.txt
  8. ./compiler.sh

where [VENV_ROOT] and [NGEN_ROOT] refer to the directory to install the python virtual environment and the root directory where ngen is installed, respectively.

Usage

Follow the following steps to test the program:

  1. source [VENV_ROOT]/env.ngen/bin/activate
  2. cd [NWM-FCST-MGR_ROOT]/nwm-fcst-mgr
  3. pip install .

where [NWM-FCST-MGR_ROOT] is where nwm-fcst-mgr is installed.

The program takes three arguments:

  1. Path to the config yaml file for a validation run (from nwm-cal-mgr)
  2. Path to a realization file for the forecast run (generated by nwm-msw-mgr)
  3. Optional Path to a realization file for the cold start run in provided by user (generated by nwm-msw-mgr)

Nwm-fcst-mgr can be run from the CLI or from Python code directly.

Python

  1. from nwm_fcst_mgr.forecast import run_fcst
  2. valid_yaml = '~/ngwpc/run_ngen/kge_dds/noah_cfes/01123000/Output/Validation_Run/01123000_config_valid_best.yaml'
  3. real_path = '~/ngwpc/run_ngen/kge_dds/noah_cfes/01123000/Output/Forecast_Run/fcst_run1/01123000_realization_config_bmi_fcst.json'
  4. run_fcst(valid_yaml=valid_yaml, real_path=real_path)

If the user wishes to run a cold_start_period, then real_path would be replaced by the path to the cold start realization file.

CLI

python -m nwm_fcst_mgr.forecast valid_yaml real_path

where the arguments are replaced by the paths above.

Docker container

Requirements

To build and run nwm-fcst-mgr, you will need the following software installed and running on your system:

  • Docker Engine

Build

To build the nwm-fcst-mgr container, execute the following command:

docker build --tag=nwm-fcst-mgr .

Running

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.