2. Python Interface

pyramses is a Python module that provides an interface to the RAMSES dynamic simulator. It covers the full simulation workflow: defining test cases, launching simulations, querying system states at runtime, and extracting and plotting results.

The package embeds pre-compiled RAMSES binaries (dynamic libraries) for both Windows and Linux and exposes them through a clean Python API.

2.1. Package-level attributes

After importing the package, the following attributes are available:

  • pyramses.__version__ — Current version string (e.g., '0.0.65')

  • pyramses.__url__ — Documentation URL (https://pyramses.sps-lab.org)

  • pyramses.__runTimeObs__ — True if Gnuplot was found in PATH at import time; runtime observables will be active

2.2. Main classes

Class

Description

pyramses.cfg

Defines a test case: data files, disturbance file, output files, observables, and runtime options.

pyramses.sim

Runs simulations. Supports start/pause/continue, runtime queries, and disturbance injection.

pyramses.extractor

Extracts and visualises time-series results from trajectory files produced by a simulation.