This section contains information for preCICE maintainers and contributors.
To see the source code documentation please visit our doxygen.
Getting started
To start developing preCICE:
- Get the preCICE source code
git clone https://github.com/precice/precice.git
- Install required dependencies
- Install additional tooling such as python polars in a separate python venv
- Setup and install pre-commit
- Configure the build using the development preset
cmake --preset=development
- Fix unity build
- Compile preCICE
- Run the tests
- Make preCICE findable
Fix Language Servers
Language servers have problems handling unity builds and may not work.
There are 3 ways to fix it:
- Download and run this python script in your build directory
./deunify -i
. You need to repeat this whenever you add source files. - Configure without the unity build
cmake -DCMAKE_BUILD_UNITY=OFF .
, thencp compile_commands.json ..
and activate unity builds againcmake -DCMAKE_BUILD_UNITY=ON .
- Disable unity builds altogether
cmake -DCMAKE_BUILD_UNITY=OFF .