docker container

A docker container bundles an application (here SWASH) with all its dependencies, including libraries, configuration files, and a lightweight OS kernel (usually Linux Ubuntu) into a single package, and can be used to run the application directly on any OS platform. To run the container, one needs to install the Docker Engine in their machine. This engine is available for Windows, Linux, and macOS via Docker Desktop.

After installing Docker Desktop, you can test SWASH and check if it runs properly. Open a terminal, copy and paste the following command into the terminal and press Enter:

docker run delftwaves/swash

This docker run command first pulls the image delftwaves/swash from the Docker Hub, which might take a few moments. Next, it creates a new container based on this image and then the SWASH executable within this container will be run. If the installation was successful, you should see a message saying that SWASH ran successfully.

To run your own SWASH application, download the official SWASH docker image from the Docker Hub repository. Like the SWASH source code, this image is distributed under GNU GPL v3 license.

Consult this page for the various run instructions.