Overview

This repository contains tools for reading and writing specified format observation-type files.

• 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:$ /path/to/git clone --recursive https://github.com/HenryWinterbottom-NOAA/ufs_obs

Dependencies

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

Dependency Package	Installation Instructions
pybufrkit	pip install pybufrkit
metpy	pip install metpy

Installing Package Dependencies

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

user@host:$ cd /path/to/ufs_obs
user@host:$ /path/to/pip install update
user@host:$ /path/to/pip install -r /path/to/ufs_obs/requirements.txt
user@host:$ ./build.sh

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

Docker Containers

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

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

To execute within the Docker container, do as follows.

user@host:$ /path/to/docker run -v /localhost/path/to/ufs_obs:/ufs_obs -v /localhost/path/to/work:/work -it ghcr.io/henrywinterbottom-noaa/ubuntu20.04.ufs_obs: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).