Important
This repository is aimed for development purposes and the default branch is develop. If you want to use the tutorials, switch to the master branch or download the latest release.
This repository contains ready-to-run tutorial cases for the coupling library preCICE. The purpose of these cases is not to teach you how to use preCICE from scratch, but to serve as starting points for setting up similar simulation cases, as well as test cases. Read more on our preCICE tutorials documentation section.
As a general rule, you can start each participant from inside their <tutorial>/<participant>-<solver> using ./run.sh. Look into these short scripts and copy the parts you need for your new case. Before running again, execute the cleaning scripts you can find at each level, to clean from this point and deeper.
Contributions to this repository are very welcome. Please refer to the page Contribute to preCICE for a few guidelines and hints to help you in this direction.
For Python dependency ranges and the sibling requirements-reference.txt files used for reproducible installs, see .dev-tools/releasing/README.md.
Note
We use Git LFS to version reference results. These will appear as seemingly empty files containing URLs if you don't have Git LFS installed (optional, mainly useful for our system tests).
We host a Git LFS server for these, which only allows push access under restrictions.
In case you get issues pushing to a fork, set GIT_LFS_SKIP_PUSH=1 or do git push --no-verify.
If you get issues pulling to a fork, set GIT_LFS_SKIP_SMUDGE=1 prior to git pull.