pynbody.family

pynbody.family#

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

Most users will not need to use this module directly. New families of particles can, however, be added interactively by creating new instances of the Family class. See the example in the class documentation.

Another way to add families, more permanently, is to use the configuration file. See the Configuring pynbody section for more information.

Functions

family_names([with_aliases])

Returns a list of the names of all particle families.

get_family(name[, create])

Returns a Family object corresponding to the specified string.

Classes

Family(name[, aliases])

The class representing an abstract family of particles.