Skip to content

Commit

Permalink
Mention future support for SOAP.
Browse files Browse the repository at this point in the history
  • Loading branch information
kyleaoman committed Sep 19, 2023
1 parent 3173d27 commit 427152e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 8 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions docs/source/halo_finders/index.rst
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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
------------------
Expand Down
2 changes: 1 addition & 1 deletion swiftgalaxy/halo_finders.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 427152e

Please sign in to comment.