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-wxdev/ufs_pyutils

Dependencies

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

Package	Installation Instructions
astropy	pip install astropy==5.2
boto3	pip boto3==1.24.28
bs4	pip install bs4==0.0.1
croniter	pip install croniter==1.3.8
lxml	pip install lxml==4.9.2
netcdf4	pip install netcdf4==1.6.2
numpy	pip install numpy==1.22.4
pyyaml	conda install -c anaconda pyyaml==6.0
rich_argparse	pip install rich_argparse==1.1.1
schema	pip install schema==0.7.5
tabulate	pip install tabulate==0.9.0
xarray	pip install xarray==0.16.2
xmltodict	pip install xmltodict==0.13.0

Installing Package Dependencies

In order to install the respective Python packages upon which ufs_pyutils is dependent, do as follow.

user@host:$ cd /path/to/ufs_pyutils
user@host:$ /path/to/pip install update
user@host:$ /path/to/pip install -r /path/to/ufs_pyutils/requirements.txt
user@host:$ /path/to/conda install -y -c conda-forge --file /path/to/ufs_pyutils/requirements.conda

For additional information using pip and requirements.txt type files, see here.

Building and Installing

In order to install via the Python setup applications, do as follows.

user@host:$ cd /path/to/ufs_pyutils
user@host:$ /path/to/python setup.py build --user
user@host:$ /path/to/python setup.py install --user

For additional information and options for building Python packages, see here.

Docker Containers

Docker containers containing the ufs_pyutils dependencies can be collected as follows.

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

To execute within the Docker container, do as follows.

user@host:$ /path/to/docker run -it ghcr.io/henrywinterbottom-wxdev/ubuntu20.04.ufs_pyutils: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_fork_name: Documentation additions and/or corrections for the application(s).

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

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

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