Installation

Install prerequisites for your operating system:

🐧 Linux🍏 macOS🚀 HPC

apt install gfortran ninja-build libsuitesparse-dev

brew install gfortran ninja suite-sparse

Run gcc --version and make sure it's actually using the GNU compiler, not Clang. Otherwise create a symbolic link gcc to gcc-13 or whatever version Homebrew installed and put it early on the search PATH.

On a high-performance compute cluster, you typically have to make at least the SuiteSparse library available. For example:

module load suite-sparse

To use the library from your own scripts, simply install it from its source repository:

pip install git+https://gitlab.ethz.ch/compmech/gripyth.git

Python 3.10 or later is required. This will also install all required Python libraries, such as NumPy, if missing.

If you intend to work on the library code yourself, refer to the development chapter for installation instructions instead.