RHESSys_docker

Configuration for running HydroShare RHESSysWorkflows models in Docker containers

Requirements for Running RHESSys in Docker

The run.py executable is used to run RHESSys in Docker. This requires that the following environment variables be set in your container:

• SRC_VOLUME: The mount point in the Docker container where the RHESSys_docker repo has been cloned
• RID: The HydroShare resource ID of the RHESSysWorkflows resource
• UUID: A one-time key to be used for posting model results to HydroShare
• INPUT_URL: The HydroShare resource file URL that will return a zipped representation of the resource
• RESPONSE_URL: The HydroShare resource URL where results should be posted to
• ABORT_URL: The HydroShare resource URL where error messages should be posted to
• MODEL_OPTIONS: JSON dictionary of options specifying how to run the model
• RHESSYS_PROJECT: The name of the RHESSysWorkflows project directory
• RHESSYS_PARAMS: The command line parameters used to run RHESSys

Optionally, the following environment variables can be set:

• RHESSYS_USE_SRC_FROM_DATA: [True | False]. If True, RHESSys source code will be compiled from the RHESSysWorkflows project instead of from the RHESSys_docker repo.

Testing run.py outside of Docker

It is possible to test the run.py executable outside of Docker. To do so, start up the provided test_server.py (to serve requests for RESPONSE_URL and ABORT_URL), and test_server_input.py (to serve INPUT_URL requests), and run run.py, for example:

SRC_VOLUME=/tmp UUID=1345f6b3a46e RID=MYRESOURCE123 RHESSYS_PROJECT=DR5_3m_nonburned_DEM_rain_duration_DEM_float_lctest RHESSYS_PARAMS="-st 2001 1 1 1 -ed 2001 1 2 1 -b -t tecfiles/tec_daily.txt -w worldfiles/world_init -r flow/world_init_res_conn_subsurface.flow flow/world_init_res_conn_surface.flow -s 1.43092108352 3.81468111311 3.04983096856 -sv 2.35626069137 49.1712407611 -gw 0.00353233818322 0.495935816914" RHESSYS_USE_SRC_FROM_DATA=True INPUT_URL=http://127.0.0.1:8081 RESPONSE_URL=http://127.0.0.1:8080 ABORT_URL=http://127.0.0.1:8080 ./run.py

Building the Docker image

To build the Docker image:

docker build .

If you run into problems building the image (e.g. missing Ubuntu packages):

docker pull ubuntu

then do:

docker build --no-cache .

Once the image is built, you should see something like:

Successfully built 538cf9bf982c

Make a tag for this image (so you won't have to remember the hash):

docker tag 538cf9bf982c rhessys

Running RHESSys within Docker

To run the Docker image:

docker run -v /tmp/RHESSys_docker:/src -e SRC_VOLUME=/src -e UUID=1345f6b3a46e -e RID=MYRESOURCE123 -e RHESSYS_PROJECT=DR5_3m_nonburned_DEM_rain_duration_DEM_float_lctest -e RHESSYS_PARAMS="-st 2001 1 1 1 -ed 2001 1 2 1 -b -t tecfiles/tec_daily.txt -w worldfiles/world_init -r flow/world_init_res_conn_subsurface.flow flow/world_init_res_conn_surface.flow -s 1.43092108352 3.81468111311 3.04983096856 -sv 2.35626069137 49.1712407611 -gw 0.00353233818322 0.495935816914" -e RHESSYS_USE_SRC_FROM_DATA=True -e INPUT_URL=http://127.0.0.1:8081 -e RESPONSE_URL=http://127.0.0.1:8080 ABORT_URL=http://127.0.0.1:8080 rhessys