Skip to content

Quick path

New to PROTEUS?

Start with the Quick start tutorial: an all-dummy run that exercises the full coupling architecture in under a minute, with no external solvers needed.

The PROTEUS documentation follows the Diataxis framework: Tutorials for learning by doing, How-to guides for specific tasks, Explanations for understanding the design, and Reference for looking up details. You can find all sections in the top navigation bar.

Quick path

  1. Prepare your local machine Set up your local environment (compilers, package managers).
    → Local machine guide

    HPC clusters

    These steps do not apply on an HPC cluster; follow the Kapteyn, Habrok, or Snellius cluster guide instead.

  2. Install PROTEUS Set up the code and required dependencies.
    → Installation guide

  3. Run the quick start tutorial Verify the installation and understand the code flow with an all-dummy run.
    → Quick start tutorial

  4. Run an Earth analogue A production-quality simulation with real physics modules.
    → Earth analogue tutorial

What do you want to do?