Merge pull request NCAR#48 from jmills-ncar/master

Updates to docker hub after training
mollymca · Jun 8, 2018 · 4cea9a7 · 4cea9a7
2 parents 8591006 + 9a12715
commit 4cea9a7
Show file tree

Hide file tree

Showing 18 changed files with 724 additions and 177 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,24 @@
+![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO
+
 # wrf_hydro_docker
 
 [![Build Status](https://travis-ci.org/NCAR/wrf_hydro_docker.svg?branch=master)](https://travis-ci.org/NCAR/wrf_hydro_docker)
 
-##Docker containers for wrf_hydro modeling system. 
+# Overview
+
+This repository contains all Dockerfiles and assosciated container contents for all images
+available on the [WRF-Hydro Dockerhub page](https://hub.docker.com/u/wrfhydro/). Some of these
+containers require large datasets. These datasets are avilable on a public GoogleDrive folder at 
+[WRF_HYDRO_DOCKER_DATA](https://drive.google.com/open?id=1NY9YdVLcJMIqE6ibLVyKe1fJ-Eoj74Kr).
+
+Each subdirectory in this repository cooresponds to a Docker image on [WRF-Hydro Dockerhub page]
+(https://hub.docker.com/u/wrfhydro/).
+
+## Where to get help and/or post issues
+If you have general questions about Docker, there are ample online resources including the excellent Docker documentation at https://docs.docker.com/.
+
+The best place ask questions or post issues with these lessons is via the Issues page of the GitHub
+repository at https://github.com/NCAR/wrf_hydro_docker/issues.
 
-Under construction
+## Usage
+Please see usage instructions in each sub-directory. 
diff --git a/dev/README.md b/dev/README.md
diff --git a/dev/Readme.md b/dev/Readme.md
@@ -0,0 +1,92 @@
+![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO
+
+Containers used for WRF-Hydro development. These containers are also suitable options for running
+WRF-Hydro simulations on a single-node system. See sub-tags (e.g. 'base', 'conda') for details on
+each container.
+
+---------------------------------------------------
+## base
+
+### Overview
+This container is used for WRF-Hydro development and single-node WRF-Hydro simulations.
+
+This container includes the following:
+
+* Ubuntu base image
+* All system libraries required by WRF-Hydro
+* Text editors - VIM, Nano, Emacs
+* git version control system
+* nccmp - NetCDF Compare utility for diffing NetCDF files
+* NetCDF C and Fortran libraries
+* MPI
+
+### Usage
+**Step 1: Pull the image**
+```
+docker pull wrfhydro/dev:base
+```
+
+**Step 2: Run the image**
+```
+docker run -it wrfhydro/dev:base
+```
+
+**Optionally: Run the image with a volume mount**
+
+**NOTE: DO NOT COMPILE WRFHYDRO IN THE MOUNTED FOLDER.**
+On some filesystems, WRF-Hydro will not compile correctly if compilation occurs in a mounted
+directory. WRF-Hydro will run in a mounted directory on most filesystems, but compilation may fail.
+
+```
+docker run -v <path-to-your-local-mount-folder>:<path-to-the-desired-docker-folder> -it wrfhydro/dev:base
+```
+
+---------------------------------------------------
+
+## conda
+
+### Overview
+This container is used for WRF-Hydro development and single-node WRF-Hydro simulations.
+
+This container includes the following:
+
+* Everything in wrfhydro/dev
+
+* Miniconda with the following libraries and all dependencies
+ + jupyterlab 
+ + jupyter_contrib_nbextensions
+ + boltons 
+ + cartopy 
+ + deepdiff 
+ + f90nml 
+ + netcdf4 
+ + pytest
+ + pytest-datadir
+ + rasterio 
+ + termcolor
+ + wrfhydropy
+ + xarray 
+
+### Usage
+**Step 1: Pull the image**
+```
+docker pull wrfhydro/dev:conda
+```
+
+**Step 2: Run the image**
+```
+docker run -it wrfhydro/dev:conda
+```
+
+**Optionally: Run the image with a volume mount**
+
+**NOTE: DO NOT COMPILE WRFHYDRO IN THE MOUNTED FOLDER.**
+On some filesystems, WRF-Hydro will not compile correctly if compilation occurs in a mounted
+directory. WRF-Hydro will run in a mounted directory on most filesystems, but compilation may fail.
+
+
+```
+docker run -v <path-to-your-local-mount-folder>:<path-to-the-desired-docker-folder> -it
+wrfhydro/dev:conda
+```
+
diff --git a/dev/base/Readme.md b/dev/base/Readme.md
@@ -0,0 +1,36 @@
+![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO
+
+# Overview
+This container is used for WRF-Hydro development and single-node WRF-Hydro simulations.
+
+This container includes the following:
+
+* Ubuntu base image
+* All system libraries required by WRF-Hydro
+* Text editors - VIM, Nano, Emacs
+* git version control system
+* nccmp - NetCDF Compare utility for diffing NetCDF files
+* NetCDF C and Fortran libraries
+* MPI
+
+# Usage
+**Step 1: Pull the image**
+```
+docker pull wrfhydro/dev:base
+```
+
+**Step 2: Run the image**
+```
+docker run -it wrfhydro/dev:base
+```
+
+**Optionally: Run the image with a volume mount**
+
+**NOTE: DO NOT COMPILE WRFHYDRO IN THE MOUNTED FOLDER.**
+On some filesystems, WRF-Hydro will not compile correctly if compilation occurs in a mounted
+directory. WRF-Hydro will run in a mounted directory on most filesystems, but compilation may fail.
+
+```
+docker run -v <path-to-your-local-mount-folder>:<path-to-the-desired-docker-folder> -it wrfhydro/dev:base
+```
+
diff --git a/dev/conda/Readme.md b/dev/conda/Readme.md
@@ -0,0 +1,47 @@
+![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO
+
+# Overview
+This container is used for WRF-Hydro development and single-node WRF-Hydro simulations.
+
+This container includes the following:
+
+* Everything in wrfhydro/dev
+
+* Miniconda with the following libraries and all dependencies
+ + jupyterlab 
+ + jupyter_contrib_nbextensions
+ + boltons 
+ + cartopy 
+ + deepdiff 
+ + f90nml 
+ + netcdf4 
+ + pytest
+ + pytest-datadir
+ + rasterio 
+ + termcolor
+ + wrfhydropy
+ + xarray 
+
+# Usage
+**Step 1: Pull the image**
+```
+docker pull wrfhydro/dev:conda
+```
+
+**Step 2: Run the image**
+```
+docker run -it wrfhydro/dev:conda
+```
+
+**Optionally: Run the image with a volume mount**
+
+**NOTE: DO NOT COMPILE WRFHYDRO IN THE MOUNTED FOLDER.**
+On some filesystems, WRF-Hydro will not compile correctly if compilation occurs in a mounted
+directory. WRF-Hydro will run in a mounted directory on most filesystems, but compilation may fail.
+
+
+```
+docker run -v <path-to-your-local-mount-folder>:<path-to-the-desired-docker-folder> -it
+wrfhydro/dev:conda
+```
+
diff --git a/domains/Readme.md b/domains/Readme.md
@@ -0,0 +1,27 @@
+![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO
+
+# THESE DOCKER DATA CONTAINERS FOR DOMAINS WILL SOON BE DEPRECATED
+These images are a temporary solution until an object store is established.
+
+# Overview 
+
+These docker data containers are used primarily by the WRF-Hydro development team. If you are
+searching for an example test case for general use, please see
+https://ral.ucar.edu/projects/wrf_hydro/testcases.
+
+Generally, these docker domain containers are used with a volume mount to one of our `wrfhydro/dev`
+containers to create a modular docker environment that contains a domain and a WRF-Hydro development environment.
+
+# Usage
+For example:
+
+```
+docker pull wrfhydro/dev:base
+docker pull wrfhydro/domains:croton_NY
+```
+
+```
+docker create --name croton_NY wrfhydro/domains:croton_NY
+docker run --volumes-from croton_NY -it wrfhydro/dev:base
+```
+