forked from NCAR/wrf_hydro_docker
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
jmills-ncar
committed
Jun 8, 2018
1 parent
cef956d
commit 9a12715
Showing
5 changed files
with
100 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,92 @@ | ||
![](https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png) WRF-HYDRO | ||
|
||
# Overview | ||
|
||
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. 'dev', 'conda') for details on | ||
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 | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters