search

hydroframe / SandTank

Sand Tank Outreach Tool
https://hydroframe.github.io/SandTank/
Other
4 stars 5 forks source link

readme

ParFlow Sandtank

Docker Docs DOI

This application aims to provide a standalone solution for simulating a specific Sand tank setup using ParFlow and an interactive Web UI for adjusting the various parameters that can be adjusted by the user.

See the full documentation here.

Build the web client

Note: Node.js version 17 or lower is required

cd ./client
npm install
npm run build

Bundle the application

Once the client as been built, the only required part for running the service is the content of the deploy directory which can be archived and shared for deploying such service in another location.

The following set of commands can be used to capture the application.

cd ./deploy
tar cvfz sandtank-app.tgz ./pvw

Run Web application with docker inside repository

cd ./

export APP=$PWD/deploy/pvw
export HOST=localhost:9000

docker run --rm                   \
  -e PROTOCOL="ws"                 \
  -p 9000:80                        \
  -e SERVER_NAME="${HOST}"           \
  -v "${APP}:/pvw"                    \
  -it hydroframe/sandtank

Open your browser to http://localhost:9000/

Use Ctrl+C to stop the container.

Run Web service using the application bundle

mkdir -p /opt/sandtank
cd /opt/sandtank
tar xvfz /.../sandtank-app.tgz

export APP=/opt/sandtank/pvw
export HOST=localhost:9100

docker run --rm                 \
  -e PROTOCOL="ws"               \
  -p 9100:80                      \
  -e SERVER_NAME="${HOST}"         \
  -v "${APP}:/pvw"                  \
  -d hydroframe/sandtank

Open your browser to http://localhost:9100/

Templates

The base Sandtank model will open by default with the procedures outlined above. To use a different template, modify the URL to open your browser to http://localhost:9100/?name=“TemplateName”. The following templates are available:

  1. default : This is the default sandtank model based on a physical sandtank model. The template is a 2D model with a width of 100 cells and height of 50 cells . It contains 4 different subsurface materials, a river/lake, landfill, and 11 wells.
  2. hillslope: This template is a 2D model with the same dimensions as the default sand tank (100 cells by 50), but it incorporates topography to include two hillslopes with a river in the middle. It has 3 different subsurface materials and 8 wells in the domain.