Getting started

The PROTEUS documentation is divided into How-to guides, Tutorials, Explanations and Reference material, which you can find in the top bar. For a quick start you can follow the path below.

Quick path

1. Prepare your local machine Set up your local environment.
   → Local machine guide

   HPC clusters

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

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

3. Configure your setup Choose and customise the model parameters for your problem.
   → Configuration

4. First PROTEUS run Execute your first simulation.
   → Using PROTEUS

What do you want to do?