Skip to content

PyRAMSES Installation

Terminal window
pip install pyramses

This installs PyRAMSES along with its core dependencies.

PyRAMSES depends on the Intel MKL redistributable libraries for LAPACK/BLAS and OpenMP. These should be automatically installed as dependencies.

To verify MKL is correctly installed:

import numpy as np
np.__config__.show()

You should see output referencing mkl_rt in the BLAS/LAPACK configuration.

PyRAMSES can display simulation outputs in real-time during execution. This requires Gnuplot to be installed and available in the system PATH.

Download and install from gnuplot.info. Make sure the installation directory is added to your system PATH.

PlatformLibraryNotes
Windowsramses.dllPrimary platform, full support
Linuxramses.soFull support with gfortran/OpenBLAS

You can override the default library directory when creating a simulator instance:

import pyramses
ram = pyramses.sim(custLibDir="/path/to/custom/libs")
import pyramses
print(pyramses.__version__) # Current version
print(pyramses.__url__) # https://pyramses.sps-lab.org