Local Machine Guide

These steps should be performed before installing PROTEUS on your computer. They do not apply when running PROTEUS on a server or HPC cluster. For instructions on configuring PROTEUS on a remote machine, see the cluster guide pages.

Once you have followed these steps, go back to the main installation guide page.

macOS

1. Open the terminal and install the Xcode developer tools:

   xcode-select --install
   

2. Install the required libraries via the most appropriate method for you.

   Homebrew (recommended)

   brew install netcdf netcdf-fortran wget gcc open-mpi
   

   MacPorts

   sudo port install netcdf-fortran +gcc8 wget gcc13 openmpi
   

   Apple Silicon (M1/M2/M3/Ultra)

   The gcc and open-mpi packages are required for compiling PETSc on Apple Silicon Macs. If you skip these, you may encounter compilation errors during the PETSc installation step. See the Troubleshooting page for details.

3. macOS Catalina (10.15) and later uses zsh as the default shell. Replace .bashrc with .zshrc throughout the installation instructions if you are using the default shell.

Debian / Ubuntu Linux

Install gfortran and the NetCDF libraries via your package manager:

sudo apt install libnetcdff-dev gfortran

Fedora / RedHat Linux

Install the required libraries via your package manager:

sudo dnf install gcc gcc-gfortran gcc-c++ netcdf netcdf-fortran netcdf-fortran-devel \
    lapack lapack-devel lapack-static sundials-mpich openmpi openmpi-devel f2c f2c-libs

Microsoft Windows

PROTEUS is not natively supported on Windows. To run PROTEUS on a Windows machine, use WSL2 (Windows Subsystem for Linux) and follow the Debian / Ubuntu Linux instructions above.

wsl --install -d Ubuntu

After installing WSL2 and launching an Ubuntu terminal, proceed with the main installation guide as on Linux.

For remote development on a cluster instead, see the VS Code Instructions for Kapteyn Cluster.