API reference

Here is the documentation for the Plonk API. It provides documentation of the available functions and classes in Plonk.

The documentation is generated from the function/class docstrings, and so is also available at the Python/IPython REPL or in a Jupyter notebook, e.g. help(plonk.load_snap) and plonk.load_snap?.

• Data
  • Snap
  • Simulation
• Analysis
  • Profiles
  • Particle filters
  • Extra particle quantities
  • Global quantities
  • Sink quantities
  • Accretion discs
  • SPH summation
• Visualization
  • Visualize
  • Animation
  • Interpolation
• Utils
  • Kernels
  • Math
  • Snap
  • Strings
  • Visualize

previous

Vertical profile in a disc

next

Data