The United States Department of Commerce (DOC) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
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_pyutils
The package dependencies and the respective repository and manual installation attributes are provided in the table below.
| Dependency Package | Installation Instructions |
|---|---|
astropy |
pip install astropy==5.2 |
boto3 |
conda install -c anaconda boto3==1.24.28 |
bs4 |
pip install bs4==0.0.1 |
croniter |
pip install croniter==1.3.8 |
netcdf4 |
pip install netcdf4==1.6.2 |
numpy |
pip install numpy==1.22.4 |
pyyaml |
conda install -c anaconda pyyaml==6.0 |
schema |
pip install schema==0.7.5 |
In order to install via the Python setup applications, do as follows.
user@host:$ cd ufs_pyutils
user@host:$ python setup.py build
user@host:$ python setup.py install
For additional information and options for building Python packages, see here
A Docker image exist containing the applications in this repository and can be collected as follows.
user@host:$ docker pull noaaufsrnr/el7-miniconda.ufs_pyutils:latest
A corresponding Singularity image may be built as follows.
user@host:$ singularity build ufs_pyutils_latest.sif docker://noaaufsrnr/noaaufsrnr/ufs_pyutils:latest
The attribute latest refers to the respective tag. For a specific tag, replace latest with the desired tag.
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).