[yt-svn] commit/yt: 2 new changesets

[commits-noreply at bitbucket.org]

2 new commits in yt:

https://bitbucket.org/yt_analysis/yt/commits/7fb031958273/
Changeset:   7fb031958273
User:        ngoldbaum
Date:        2018-02-23 20:24:06+00:00
Summary:     add a few classes from the halo finder frontends to the API docs
Affected #:  2 files

diff -r f13e950937f099d722c60abacd8f2215c5f55741 -r 7fb031958273d2dc98f0e3bcce6dcd3a3e4c9677 doc/source/examining/loading_data.rst
--- a/doc/source/examining/loading_data.rst
+++ b/doc/source/examining/loading_data.rst
@@ -1654,7 +1654,7 @@
 Halo Catalog Data
 -----------------
 
-yt has support for reading halo catalogs produced by AHF, Rockstar and the inline
+yt has support for reading halo catalogs produced by the Amiga Halo Finder (AHF), Rockstar and the inline
 FOF/SUBFIND halo finders of Gadget and OWLS.  The halo catalogs are treated as
 particle datasets where each particle represents a single halo.  For example,
 this means that the `particle_mass` field refers to the mass of the halos.  For
@@ -1669,13 +1669,13 @@
 
 .. _ahf:
 
-AHF
-^^^
-
-AHF halo catalogs are loaded by providing the path to the .parameter files.
-The corresponding .log and .AHF_halos files must exist for data loading to
-succeed. The field type for all fields is "halos". Some fields of note available
-from AHF are:
+Amiga Halo Finder
+^^^^^^^^^^^^^^^^^
+
+Amiga Halo Finder (AHF) halo catalogs are loaded by providing the path to the
+.parameter files.  The corresponding .log and .AHF_halos files must exist for
+data loading to succeed. The field type for all fields is "halos". Some fields
+of note available from AHF are:
 
 +----------------+---------------------------+
 | AHF field      | yt field name             |

diff -r f13e950937f099d722c60abacd8f2215c5f55741 -r 7fb031958273d2dc98f0e3bcce6dcd3a3e4c9677 doc/source/reference/api/api.rst
--- a/doc/source/reference/api/api.rst
+++ b/doc/source/reference/api/api.rst
@@ -294,6 +294,16 @@
 
 .. autosummary::
 
+   ~yt.frontends.ahf.data_structures.AHFHalosDataset
+   ~yt.frontends.ahf.fields.AHFHalosFieldInfo
+   ~yt.frontends.ahf.io.IOHandlerAHFHalos
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFDataset
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHDF5File
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHaloDataset
+   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHDF5
+   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHaloHDF5
+   ~yt.frontends.gadget_fof.fields.GadgetFOFFieldInfo
+   ~yt.frontends.gadget_fof.fields.GadgetFIFHaloFieldInfo
    ~yt.frontends.halo_catalog.data_structures.HaloCatalogHDF5File
    ~yt.frontends.halo_catalog.data_structures.HaloCatalogDataset
    ~yt.frontends.halo_catalog.fields.HaloCatalogFieldInfo


https://bitbucket.org/yt_analysis/yt/commits/04a209248af3/
Changeset:   04a209248af3
User:        ngoldbaum
Date:        2018-02-24 00:01:22+00:00
Summary:     Merge pull request #1704 from ngoldbaum/halo-api-docs

add a few classes from the halo finder frontends to the API docs
Affected #:  2 files

diff -r f13e950937f099d722c60abacd8f2215c5f55741 -r 04a209248af337415ce2e05cd7c82551592464e3 doc/source/examining/loading_data.rst
--- a/doc/source/examining/loading_data.rst
+++ b/doc/source/examining/loading_data.rst
@@ -1654,7 +1654,7 @@
 Halo Catalog Data
 -----------------
 
-yt has support for reading halo catalogs produced by AHF, Rockstar and the inline
+yt has support for reading halo catalogs produced by the Amiga Halo Finder (AHF), Rockstar and the inline
 FOF/SUBFIND halo finders of Gadget and OWLS.  The halo catalogs are treated as
 particle datasets where each particle represents a single halo.  For example,
 this means that the `particle_mass` field refers to the mass of the halos.  For
@@ -1669,13 +1669,13 @@
 
 .. _ahf:
 
-AHF
-^^^
-
-AHF halo catalogs are loaded by providing the path to the .parameter files.
-The corresponding .log and .AHF_halos files must exist for data loading to
-succeed. The field type for all fields is "halos". Some fields of note available
-from AHF are:
+Amiga Halo Finder
+^^^^^^^^^^^^^^^^^
+
+Amiga Halo Finder (AHF) halo catalogs are loaded by providing the path to the
+.parameter files.  The corresponding .log and .AHF_halos files must exist for
+data loading to succeed. The field type for all fields is "halos". Some fields
+of note available from AHF are:
 
 +----------------+---------------------------+
 | AHF field      | yt field name             |

diff -r f13e950937f099d722c60abacd8f2215c5f55741 -r 04a209248af337415ce2e05cd7c82551592464e3 doc/source/reference/api/api.rst
--- a/doc/source/reference/api/api.rst
+++ b/doc/source/reference/api/api.rst
@@ -294,6 +294,16 @@
 
 .. autosummary::
 
+   ~yt.frontends.ahf.data_structures.AHFHalosDataset
+   ~yt.frontends.ahf.fields.AHFHalosFieldInfo
+   ~yt.frontends.ahf.io.IOHandlerAHFHalos
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFDataset
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHDF5File
+   ~yt.frontends.gadget_fof.data_structures.GadgetFOFHaloDataset
+   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHDF5
+   ~yt.frontends.gadget_fof.io.IOHandlerGadgetFOFHaloHDF5
+   ~yt.frontends.gadget_fof.fields.GadgetFOFFieldInfo
+   ~yt.frontends.gadget_fof.fields.GadgetFIFHaloFieldInfo
    ~yt.frontends.halo_catalog.data_structures.HaloCatalogHDF5File
    ~yt.frontends.halo_catalog.data_structures.HaloCatalogDataset
    ~yt.frontends.halo_catalog.fields.HaloCatalogFieldInfo

Repository URL: https://bitbucket.org/yt_analysis/yt/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.