Pynbody reference documentation

The reference documentation for pynbody is largely generated automatically from the source code. It is split into sections by subpackage, as follows.

pynbody.analysis	Tools for scientific analysis with pynbody
pynbody.array	Defines arrays for simulation snapshots.
pynbody.bridge	Tools for connecting different simulation snaphots
pynbody.chunk	Methods for describing parts of files to load.
pynbody.configuration	Read and expose configuration information for pynbody
pynbody.dependencytracker	Tools for tracking how derived arrays depend on other arrays
pynbody.derived	Functions that derive arrays (e.g. radius) from others (e.g. position).
pynbody.family	Defines the Family class which represents families of particles (e.g. dm, gas, star particles).
pynbody.filt	Filters are used to define subsets of simulations, especially (but not exclusively) spatial sub-regions.
pynbody.gravity	Routines for calculating gravitational potential and accelerations.
pynbody.halo	Support for halo and group catalogues.
pynbody.kdtree	Efficient 3D KDTree implementation for fast geometrical calculations such as neighbour lists and smoothing lengths.
pynbody.openmp	Interface to OpenMP functions
pynbody.plot	Useful plotting routines, using matplotlib to display pynbody's calculations
pynbody.simdict	Defines an augmented dictionary class that manages properties of SimSnap objects
pynbody.snapshot	Implements classes to load and manipulate snapshot data
pynbody.sph	Low-level functionality for SPH interpolation and rendering
pynbody.test_utils	Utilities for downloading and unpacking test data packages
pynbody.transformation	Module for describing, applying and reverting Galilean transformations on simulations.
pynbody.units	A set of classes for tracking units.
pynbody.util	Routines used internally by pynbody.