jamal919/swash repository overview

⁠SWASH in docker

This is an independent dockerized version of the SWASH model for easy deployment and sharing. SWASH is distributed under its orignal license.

⁠Installation

To run the docker, one needs to install docker in their system. The docker is tested run on WINDOWS, LINUX, and MAC (both Intel and Apple Silicon chips).

Step 1. Install Docker for Windows⁠, Linux⁠, Mac⁠. The installer size of docker is ~600MB.

Step 2. Open your terminal (linux, mac) or cmd/powershell (windows), and run docker pull jamal919/swash:8.01. This will download the docker which contains the compiled swash-8.01 model.

NOTE: You will need to keep your docker desktop running, open or in the tray, to access the docker commands.

⁠Usage

The docker images are run using docker run <imagename> command, which creates a container from the image, run the tasks, and exit. However, for practical purposes, one needs to add some extra flags to the run command.

⁠Interactive mode

To run the docker with mounting a certain location to /mnt of the docker in interactive mode (-it) and without retaining the exited docker (--rm) the following command can be used -

docker run -it --rm -v /path/in/the/local/system:/mnt jamal919/swash:8.01

If you want to run the docker in the current directory, use the following command -

# In linux or mac
docker run -it --rm -v `pwd`:/mnt jamal919/swash:8.01

# In windows (use Powershell, PWD is not available in CMD)
docker run -it --rm -v ${PWD}:/mnt jamal919/swash:8.01

Once inside the interactive terminal, one can access all the commands available from SWASH - e.g., swash.exe, swashrun etc.

⁠Non-interactive mode

If you want to run the commands in non-interactive mode, e.g., the commands will be executed and the docker will exit, you can remove -it flag and provide your command at the end of the previously shown commands. For example, if you want to run swashrun -input your_input on a file located in the current directory pwd, then the command will look like the following -

docker run -it --rm -v `pwd`:/mnt jamal919/swash:8.01 swashrun -input <file> <etc>

⁠Tips

For simplicity, one can create a batch or shell script with the above commands and run the model by launching the script.