Installation
There are two ways to install SurfATT:
Option A: Package install (Conda / Mamba)
The quickest way to get started — install a prebuilt package from conda-forge, no compiler required. See Package Install.
Option B: Build from source
Build from source if you need a custom configuration (single-precision floating-point values, a specific MPI implementation, or an HPC module environment). This has two stages:
- Install the compilers, libraries, and build tools required by SurfATT.
- Download and compile SurfATT on your local machine or HPC system.
1. Install dependencies
Start with Dependencies. Choose the package manager that matches your environment:
- Conda / Mamba for an isolated, reproducible toolchain.
- Homebrew for macOS on Apple Silicon or Intel.
- APT or DNF for Linux workstations.
- Environment modules for managed HPC systems.
Conda is one way to install SurfATT’s build dependencies; it is not the same as the package install above.
2. Build SurfATT
After the dependencies are ready, choose the build instructions for your system:
- Build on a Local Machine for Linux and macOS workstations.
- Build on an HPC System for module-based clusters and custom MPI stacks.
Run an example
After installation, continue with Guides for the full first-run workflow.
Last updated on