https://github.com/seissol/training
https://github.com/seissol/training
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/seissol/training
- Owner: SeisSol
- License: bsd-3-clause
- Created: 2020-10-08T15:25:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T11:48:23.000Z (over 1 year ago)
- Last Synced: 2025-03-21T17:25:29.496Z (about 1 year ago)
- Language: Jupyter Notebook
- Size: 86.5 MB
- Stars: 14
- Watchers: 7
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Training
Welcome to the SeisSol training. Please clone this repository with git (using the command line) or download it directly from the browser.
This repository contains a Dockerfile to build a Docker container.
The Docker container contains an interactive learning environment (Jupyter) which includes meshing tools, SeisSol, and visualiation tools.
## Installation
Please install [Docker](https://docs.docker.com/engine/install/), launch the Docker Desktop and then run
(i) For Frontera and all Intel/AMD machines:
- use label: latest
(ii) Macs with M1/M2/M3 ARM CPUs:
- use label: hps-2024-remote-arm
```bash
docker pull seissol/training:{label}
```
## Training
After installation, run
```bash
docker run -p 53155:53155 seissol/training:{label}
```
or run the [start.sh](start.sh) script.
After some time you should see
```bash
http://127.0.0.1:53155/lab?token=some5cryptic8hash123
```
Click on that link or enter the link in the address bar of your favourite web browser.
Then use the navigation bar to open the exercises (e.g., [tpv13/tpv13.ipynb](tpv13/tpv13.ipynb)).
## Tools
You can also use the tools in the Docker container for creating input files or running SeisSol on your local computer.
To this end, you need to mount your local drive within the Docker container with the following command:
```bash
docker run -v $(pwd):/shared/ -u $(id -u):$(id -g) seissol/training
```
As this command is rather long, we provide the wrapper script [tool.sh](tool.sh).
The following tools are currently included:
- PUMGen (mesh generation for SeisSol, https://github.com/SeisSol/PUMGen, see also SeisSol's documentation https://seissol.readthedocs.io/en/latest/meshing-with-pumgen.html)
- GMSH (open source 3D finite element mesh generator, client only, https://gmsh.info)
- rconv (tool to describe point and finite source models in SeisSol's NetCDF Rupture Format, https://seissol.readthedocs.io/en/latest/standard-rupture-format.html#how-to-use-rconv)
- SeisSol O4 (pre-compiled SeisSol with 4th order space-time accuracy for elastic and viscoelastic materials, https://seissol.readthedocs.io). We use the SeisSol `v1.0.1`. See the first lines of the SeisSol output to get the exact commit hash.
I.e.
```
./tool.sh pumgen
./tool.sh gmsh
./tool.sh rconv
./tool.sh seissol
```