Pynbody reference documentation

Pynbody reference documentation#

The reference documentation for pynbody is largely generated automatically from the source code. It is split into the following sections:

Core functionality#

pynbody.array

Arrays for simulation data

pynbody.bridge

Tools for connecting different simulation snaphots

pynbody.configuration

Read and expose configuration information for pynbody

pynbody.derived

Functions that derive arrays (e.g. radius) from others (e.g. position).

pynbody.filt

Filters are used to define subsets of simulations, especially (but not exclusively) spatial sub-regions.

pynbody.halo

Support for halo and group catalogues.

pynbody.snapshot

Implements classes to load and manipulate snapshot data

pynbody.transformation

Module for describing, applying and reverting Galilean transformations on simulations.

pynbody.units

units

Scientific analysis#

pynbody.analysis

Tools for scientific analysis with pynbody

pynbody.gravity

Gravity-related routines

pynbody.plot

Low-level detail#

pynbody.chunk

Methods for describing parts of files to load.

pynbody.dependencytracker

Tools for tracking how derived arrays depend on other arrays

pynbody.family

Defines the Family class which represents families of particles (e.g. dm, gas, star particles).

pynbody.kdtree

Efficient 3D KDTree implementation for fast geometrical calculations such as neighbour lists and smoothing lengths.

pynbody.openmp

Interface to OpenMP functions

pynbody.simdict

simdict

pynbody.sph

sph

pynbody.test_utils

pynbody.util

util