Overview

This repository contains tools for creating and executing workflows using supported engines. The tools within this package currently support both Cylc and Rocoto workflow engine applications.

• Authors: Henry R. Winterbottom
• Maintainers: Henry R. Winterbottom
• Version: 0.0.1
• License: LGPL v2.1
• Copyright: Henry R. Winterbottom

Cloning

This repository utilizes several sub-modules from various sources. To obtain the entire system, do as follows.

user@host:$ git clone --recursive https://github.com/HenryWinterbottom-NOAA/ufs_engines

Dependencies

The package dependencies and the respective repository and manual installation attributes are provided in the table below.

Note that rocoto is not available via PyPI and must be installed as instructed within the respective repository. Further, only versions <=7.9.3 of cylc-flow are supported by the tools within this package.

Docker Containers

A Docker container containing the latest supported image can be obtained as follows.

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

The Docker container may then be used as follows.

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

Forking

If a user wishes to contribute modifications done within their respective fork(s) to the authoritative repository, we request that the user first submit an issue and that the fork naming conventions follow those listed below.

• docs/user_branch_name: Documentation additions and/or corrections for the application(s).

• feature/user_branch_name: Additions, enhancements, and/or upgrades for the application(s).

• fix/user_branch_name: Bug-type fixes for the application(s) that do not require immediate attention.

• hotfix/user_branch_name: Bug-type fixes which require immediate attention to fix issues that compromise the integrity of the respective application(s).