diff --git a/README.rst b/README.rst index fc17c83..3ec4a00 100644 --- a/README.rst +++ b/README.rst @@ -12,11 +12,10 @@ SWIFTGalaxy .. INTRO_START_LABEL -SWIFTGalaxy is a module that extends SWIFTSimIO_ tailored to analyses of particles belonging to individual simulated galaxies. It inherits from and extends the functionality of the ``SWIFTDataset``. It understands the output of a halo finder (supported: `Velociraptor`_; planned support: `HBT+`_) and therefore which particles belong to a galaxy, and its integrated properties. The particles occupy a coordinate frame that is enforced to be consistent, such that particles loaded on-the-fly will match e.g. rotations and translations of particles already in memory. Intuitive masking of particle datasets is also enabled. Finally, some utilities to make working in cylindrical and spherical coordinate systems more convenient are also provided. +SWIFTGalaxy is a module that extends SWIFTSimIO_ tailored to analyses of particles belonging to individual simulated galaxies. It inherits from and extends the functionality of the ``SWIFTDataset``. It understands the output of a halo finder (supported: `Velociraptor`_; planned support: `SOAP`) and therefore which particles belong to a galaxy, and its integrated properties. The particles occupy a coordinate frame that is enforced to be consistent, such that particles loaded on-the-fly will match e.g. rotations and translations of particles already in memory. Intuitive masking of particle datasets is also enabled. Finally, some utilities to make working in cylindrical and spherical coordinate systems more convenient are also provided. .. _SWIFTSimIO: http://swiftsimio.readthedocs.org .. _Velociraptor: https://ui.adsabs.harvard.edu/abs/2019PASA...36...21E/abstract -.. _HBT+: https://ui.adsabs.harvard.edu/abs/2018MNRAS.474..604H/abstract .. INTRO_END_LABEL diff --git a/docs/source/halo_finders/index.rst b/docs/source/halo_finders/index.rst index 7152de2..a0a8e63 100644 --- a/docs/source/halo_finders/index.rst +++ b/docs/source/halo_finders/index.rst @@ -1,7 +1,7 @@ Halo finders ============ -:mod:`swiftgalaxy` uses a helper class to create a uniform interface to outputs from different halo finders. Provided a python library to read the halo finder outputs already exists, this helper class is usually lightweight and easy to create. Currently, the Velociraptor halo finder has built-in support, and support for HBT+ is planned. Other halo finders may be supported on request -- pull requests to the repository are also welcome. +:mod:`swiftgalaxy` uses a helper class to create a uniform interface to outputs from different halo finders. Provided a python library to read the halo finder outputs already exists, this helper class is usually lightweight and easy to create. Currently, the Velociraptor halo finder has built-in support, and support for SOAP is planned. Other halo finders may be supported on request -- pull requests to the repository are also welcome. The second argument to create a :class:`~swiftgalaxy.reader.SWIFTGalaxy` is an instance of a class derived from the base helper class :class:`~swiftgalaxy.halo_finders._HaloFinder`, such as :class:`~swiftgalaxy.halo_finders.Velociraptor`. This object has multiple roles. It will be aware of: @@ -71,12 +71,10 @@ These can be used as, for example: centre_type='mbp' ) -HBT+ +SOAP ---- -Future support for `HBT+`_ is planned. - -.. _HBT+: https://ui.adsabs.harvard.edu/abs/2018MNRAS.474..604H/abstract +Future support for `SOAP` is planned. Other halo finders ------------------ diff --git a/swiftgalaxy/halo_finders.py b/swiftgalaxy/halo_finders.py index 74f70ab..d552801 100644 --- a/swiftgalaxy/halo_finders.py +++ b/swiftgalaxy/halo_finders.py @@ -2,7 +2,7 @@ This module contains classes providing interfaces to halo finders used with SWIFT so that :mod:`swiftgalaxy` can obtain the information it requires in a streamlined way. Currently only the Velociraptor_ halo finder is supported, but -support for other halo finders (e.g. `HBT+`_) is planned. +support for other halo finders (e.g. `SOAP`, `HBT+`_) is planned. .. _Velociraptor: https://ui.adsabs.harvard.edu/abs/2019PASA...36...21E/\ abstract