pynbody 2.0.0rc1

Astronomical N-body/SPH analysis for python

pynbody

Pynbody is an analysis framework for N-body and hydrodynamic astrophysical simulations supporting PKDGRAV/Gasoline, Gadget, Gadget4/Arepo, N-Chilada and RAMSES AMR outputs. Python version support adheres roughly to SPEC0.

Documentation

The documentation is at readthedocs. To get a first sense of what pynbody can do, try the quick-start tutorial or images tutorial.

Getting started

If python and the standard pip package manager is installed and properly configured, you can simply do:

$ pip install --pre pynbody

At the moment, we encourage new users to use pynbody version 2 release candidate, which is why the --pre flag is applied. If you need strict backwards compatibility, omit --pre. Version 2 will soon become the default (likely by the end of 2024).

If this fails, you may need some more detailed installation instructions.

Contributing

Help us make pynbody better! As you develop analysis for your science with pynbody, consider making your code available for everyone else to use. You can do this by creating a tutorial or by adding your code to the relevant sub-module and submitting a pull request (make a fork first — see https://help.github.com/articles/using-pull-requests).

Acknowledging the code

When using pynbody, please acknowledge it by citing the Astrophysics Source Code Library entry. Optionally you can also cite the Zenodo DOI for the specific version of pynbody that you are using, which may be found here.

Support and Contact

If you have trouble with Pynbody or you have feature requests/suggestions you can submit an issue, and/or send us an email on the Usergroup mailing list.