Skip to content

Latest commit

 

History

History
112 lines (81 loc) · 5.66 KB

README.md

File metadata and controls

112 lines (81 loc) · 5.66 KB
Raw

License Linux Python Version Code style: black Documentation Status

Python Coding Standards Container Builds

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_tcdiags

Dependencies

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

Dependency Package
Installation Instructions
pip install basemap
pip install basemap-data-hires
pip install cmocean
pip install jupyterlab
pip install matplotlib
pip install mycolorpy
pip install notebook
pip install pyahocorasick
pip install tcmarkers
pip install tcpypi
pip install git+https://www.github.com/HenryWinterbottom-NOAA/ufs_diags.git
pip install git+https://www.github.com/HenryWinterbottom-NOAA/ufs_obs.git

Installing Package Dependencies

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

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

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

Docker Containers

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

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

The Docker container may then be used as follows.

user@host:$ /path/to/docker container run -it ghrc.io/henrywinterbottom-noaa/ubuntu20.04.ufs_tcdiags:latest
user@host:$ cd /home/ufs_tcdiags

Running Jupyter Notebooks from Docker

The Jupyter notebooks may be launched from within the Docker container as follows.

user@host:$ /path/to/docker container run -it ghrc.io/henrywinterbottom-noaa/ubuntu20.04.ufs_tcdiags:latest
user@host:$ cd /home/ufs_tcdiags/jupyter/notebooks
user@host:$ /path/to/jupyter notebook --ip=0.0.0.0 --port=8888 --no-browser --allow-root <notebook>
user@host:$ export UFS_TCDIAGS=/home/ufs_tcdiags

This action will produce a local HTML path and an associated token as follows.

To access the server, open this file in a browser:
    file:///root/.local/share/jupyter/runtime/jpserver-21362-open.html
Or copy and paste one of these URLs:
    http://5186640b39b0:8889/tree?token=abcdefghijklmnopqrstuvwxwy0123456789ABCDEFGHIJKL
    http://127.0.0.1:8889/tree?token=abcdefghijklmnopqrstuvwxwy0123456789ABCDEFGHIJKL

Copy the paste the token attribute beginning with http://127.0.0.1:8889 into a web browser address bar and execute the respective Jupyter notebook(<notebook> above) as usual.

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).