.. _home:

.. snapAnalysis documentation master file, created by
   sphinx-quickstart on Fri May 22 16:15:06 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

``snapAnalysis`` documentation
==============================

``snapAnalysis`` is an N-body simulation snapshot analysis package. ``snapAnalysis`` is designed specifically for working with idealized simulations of at most a few galaxies, rather than cosmological simulations. Currently, it supports any GADGET-format snapshots stored in the hdf5 format, though compatibility with older GADGET binary files is planned for the future. ``snapAnalysis`` can also handle fuzzy dark matter snapshots generated by Arepo's BECDM module. 

``snapAnalysis`` supports many common workflows for handling snapshots, including particle loading, particle filtering, centering, rotations, coordinate transformations, galaxy shape analysis, particle orbit extraction, galaxy center-of-mass orbit extraction, and more. Also included are a few basic visualization functions for plotting density and potential fields, density and anisotropy profiles, and more. Units are detected automatically from snapshot headers and handled using astropy's units module. 

.. note::
   ``snapAnalysis`` is still in early development. We encourage contributions following `our guidelines <https://github.com/hfoote/snapAnalysis/blob/main/CONTRIBUTING.md>`__.

Contents
--------
.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Installation <installation>
   Tutorials <tutorials/tutorials>
   User Guide <api/modules>