Getting started#
Python version support#
goSPL supports Python 3.11 and 3.12.
Installation instructions#
The easiest way to start using goSPL is to install it from the pre-built
geodels conda package or from its Docker image. Both approaches avoid
building goSPL’s Fortran/Cython extensions locally. Instructions for
installing from source and deploying on HPC systems (NCI Gadi, Pawsey
Setonix) are also provided.
Docker image
The geodels/gospl-examples
image packages the full gospl-smoke conda environment (goSPL, PETSc,
GMT, VTK, JupyterLab) and is the recommended way to run the examples
without a local conda install.
Conda environment
Install goSPL from the pre-built geodels conda channel in one
command, or build a full environment from environment.yml for
editable/source installs.
Install from PyPI
Drop goSPL into a conda environment (or any env that already supplies
MPI / PETSc / parallel HDF5) via pip install gospl. No binary
wheel — the Fortran extension is compiled at install time.
Install from source
Build goSPL from the git source tree. Requires MPICH, PETSc ≥ 3.21, and the full scientific Python stack. Recommended for experienced users on Linux.
Install on HPC
Deploy goSPL on NCI Gadi (PBS) or Pawsey Setonix (Slurm) — either as a virtual-environment native install or inside a Singularity/ Apptainer container.