PyRAMSES Installation
Installation
Section titled “Installation”pip install pyramsesThis installs PyRAMSES along with its core dependencies.
Install PyRAMSES with all recommended packages:
pip install matplotlib scipy numpy mkl jupyter ipython pyramsesDependencies
Section titled “Dependencies”PyRAMSES depends on the Intel MKL redistributable libraries for LAPACK/BLAS and OpenMP. These should be automatically installed as dependencies.
Verifying MKL
Section titled “Verifying MKL”To verify MKL is correctly installed:
import numpy as npnp.__config__.show()You should see output referencing mkl_rt in the BLAS/LAPACK configuration.
Optional: Gnuplot for Real-Time Plots
Section titled “Optional: Gnuplot for Real-Time Plots”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.
sudo apt-get install gnuplot-x11sudo dnf install gnuplotPlatform Support
Section titled “Platform Support”| Platform | Library | Notes |
|---|---|---|
| Windows | ramses.dll | Primary platform, full support |
| Linux | ramses.so | Full support with gfortran/OpenBLAS |
Custom Library Path
Section titled “Custom Library Path”You can override the default library directory when creating a simulator instance:
import pyramsesram = pyramses.sim(custLibDir="/path/to/custom/libs")Version Information
Section titled “Version Information”import pyramsesprint(pyramses.__version__) # Current versionprint(pyramses.__url__) # https://pyramses.sps-lab.orgNext Steps
Section titled “Next Steps”- API Reference — Full API documentation
- Examples — Practical usage examples