Tools for UFS Applications#

Description#

This following documentation provides configuration and run-time examples for Unified Forecasting System (UFS) tools.

Developers#

Cloning#

The ufs_tools repository may be obtained as follows.

user@host:$ /path/to/git clone --recursive https://www.github.com/HenryWinterbottom-NOAA/ufs_tools ./ufs_tools

Installing Python Dependencies#

Install the necessary Python dependencies as follows.

user@host:$ /path/to/conda install --file /path/to/ufs_toos/requirments.conda
user@host:$ /path/to/pip install -r /path/to/ufs_tools/requirements.pip

Note that the conda fulfillment task may take longer than expected depending on both package dependency matching and the conda server availablity.

Prepared Application Files#

Files prepared by and for the supported applications can be collected as follows.

user@host:$ /path/to/aws s3 cp s3://ufs-tools/ufs_tools.tar.gz . --no-sign-request

The /path/to/aws refers to the Amazon Web Services CLI.

Container Environments#

A Docker container environments, supporting and within which the ufs_tools applications can be built and executed, may be obtained as follows.

To build the Docker container, do as follows.

user@host:$ cd /path/to/ufs_tools/Docker
user@host:$ /path/to/docker build -f ubuntu20.04.ufs_tools.dockerfile --tag ghcr.io/henrywinterbottom-noaa/ubuntu20.04.ufs_tools:latest .

To pull a Docker ufs_tools image from the Docker repository, do as follows.

user@host:$ /path/to/docker pull ghcr.io/henrywinterbottom-noaa/ubuntu20.04.ufs_tools:latest

The above will retrieve the respective image tagged as latest. Finally, to execute within the container the following can be done.

user@host:$ /path/to/docker container run -it ghcr.io/henrywinterbottom-noaa/ubuntu20.04.ufs_tools:latest

Additional attributes that can be employed when launching the respective Docker container can be found here.

Applications#