Skip to content

Latest commit

 

History

History
90 lines (43 loc) · 2.28 KB

File metadata and controls

90 lines (43 loc) · 2.28 KB

Python Reference

The pyproject.toml of this repository primarily contains requirements for building documentation. The build sequence of the nwm-rte image is dynamic/configurable and involves multiple Python virtual environments.

CLI Help Menus

These are raw outputs of the --help menu generated by Python's argparse library.

To update these, run: ./docs/update_python_cli_ref.sh

run_default.py --help

run_calibration.py --help

run_forecast.py --help

run_tests.py --help

run_regionalization.py --help

CLI Executable Modules

run_default.py

Called by run_default.sh

run_default.py --help

::: run_default

run_calibration.py

Called by run_calib.sh

run_calibration.py --help

::: run_calibration

run_forecast.py

Called by run_fcst.sh

run_forecast.py --help

::: run_forecast

run_tests.py

Called by run_tests.sh

run_tests.py --help

::: run_tests

Python Constants

Currently bin_mounted/consts.py contains variables which rarely need editing, except for the MODELS formulation list. Soon, the MODELS variable will be parameterized as CLI argument(s).

::: consts options: members: - MODELS

Configuration Classes

These mimic the CLI interfaces and perform some additional argument parsing and preparation of classes that are passed to other components of the system.

::: configs

Regionalization Workflows

The regionalization workflows run via command-line interface (CLI) Scripts.

Here is the argparse help menu of run_regionalization.py:

run_regionalization.py --help

run_regionalization is called by run_region.sh

For more information, see the nwm-region-mgr repository.

::: run_regionalization