Documentation (HTML)

This is the up-to-date (version 4.0.0) online PyMSES manual.

All the examples presented in this manual are based on RAMSES data available here : RAMSES Data examples.

• User’s guide
  • PyMSES : Python modules for RAMSES
    • Introduction
      • What PyMSES is NOT
    • Downloads
    • Documentation
    • Contacts
    • Indices and tables
  • Installing PyMSES
    • Requirements
      • Core dependencies
      • Recommended dependencies
      • Delevoper dependencies
    • Installation instructions
  • Get a RAMSES output into PyMSES
    • RAMSES output selection
    • Ouput information
  • Reading particles
    • Particle data source
    • PointDataset
      • Single CPU particle dataset
      • Number of particles
      • Particle coordinates
      • Particle fields
    • Whole point data source concatenation
    • CPU-by-CPU particles
  • AMR data access
    • AMR data source
    • AMR data handling
      • AMR grid to cell list conversion
      • AMR field point-sampling
  • RAMSES AMR file formats
    • Default
    • User-defined
    • User-defined output file
  • Dealing with units
    • Dimensional physical constants
    • RAMSES data units
  • Data filtering
    • Region filter
    • The CellsToPoints filter
    • Function filters
    • Randomly decimated data
    • Combining filters
  • Analysis tools
    • Profile computing
      • Cylindrical profile of an AMR scalar field
        • Reading AMR data from the RAMSES output
        • Random sampling of the AMR data fields in a given region of interest
        • Computing the profile from the point-based samples
      • Spherical profile of a set of particle data
        • Reading particle data from a RAMSES output
        • Filtering all the initial particles within a given region of interest
        • Computing the profile
  • Visualization tools
    • Camera and Operator
      • Camera
        • Saving / loading a Camera
        • Other utility functions
      • Operator
    • Maps
      • Slices
        • Intro
        • Example
      • FFT-convolved maps
        • Intro
        • Examples
          • Particles map
          • AMR data map
      • Ray-traced maps
        • Intro
        • Examples
          • Density map
          • Min. temperature map
          • Max. AMR level of refinement map
        • Multiprocessing
    • AMRViewer GUI
      • Starting the GUI
      • Loading AMR data
      • Playing with the camera
      • The Region Finder
      • Other map types, other tabs
        • Magnifier
        • Rule
• Source documentation
  • Data structures and containers
    • pymses.core.sources — PyMSES generic data source module
    • pymses.core.datasets — PyMSES generic dataset module
    • Dataset transformations
      • pymses.core.transformations Geometrical transformations module
  • Sources module
    • pymses.sources — Source file formats package
    • pymses.sources.ramses.output — RAMSES output package
    • pymses.sources.ramses.sources — RAMSES data sources module
    • pymses.sources.hop — HOP data sources package
  • Filters module
    • pymses.filters — Data sources filters package
  • Analysis module
    • Visualization module
      • pymses.analysis.visualization — Visualization module
      • pymses.analysis.visualization.fft_projection — FFT-convolved map module
      • pymses.analysis.visualization.raytracing — Ray-tracing module
    • pymses.analysis — Analysis and post-processing package
  • Utilities package
    • Dimensional physical constants
      • pymses.utils.constants — physical units and constants module
    • Geometrical region module
      • pymses.utils.regions — Regions module