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:

  1. Get the preCICE source code git clone https://github.com/precice/precice.git
  2. Install required dependencies
  3. Install additional tooling such as python polars in a separate python venv
  4. Setup and install pre-commit
  5. Configure the build using the development preset cmake --preset=development
  6. Fix unity build
  7. Compile preCICE
  8. Run the tests
  9. Make preCICE findable

Fix Language Servers

Language servers have problems handling unity builds and may not work.

There are 3 ways to fix it:

  1. Download and run this python script in your build directory ./deunify -i. You need to repeat this whenever you add source files.
  2. Configure without the unity build cmake -DCMAKE_BUILD_UNITY=OFF ., then cp compile_commands.json .. and activate unity builds again cmake -DCMAKE_BUILD_UNITY=ON .
  3. Disable unity builds altogether cmake -DCMAKE_BUILD_UNITY=OFF .

Other important basics