diff --git a/doc/source/images/streamspraydf-b14-xz-wstreamdf.png b/doc/source/images/streamspraydf-b14-xz-wstreamdf.png deleted file mode 100644 index 3e9163cd8..000000000 Binary files a/doc/source/images/streamspraydf-b14-xz-wstreamdf.png and /dev/null differ diff --git a/doc/source/reference/df.rst b/doc/source/reference/df.rst index 008e311a6..3c155615b 100644 --- a/doc/source/reference/df.rst +++ b/doc/source/reference/df.rst @@ -348,5 +348,13 @@ General instance routines .. toctree:: :maxdepth: 1 - __init__ sample + +Specific particle-spray models ++++++++++++++++++++++++++++++++ + +.. toctree:: + :maxdepth: 1 + + Chen et al. (2024) + Fardal et al. (2015) diff --git a/doc/source/reference/streamspraydf.rst b/doc/source/reference/streamspraydf.rst deleted file mode 100644 index a0a97f897..000000000 --- a/doc/source/reference/streamspraydf.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _api_streamspraydf: - -The particle-spray stream DF -============================ - -.. autoclass:: galpy.df.chen24spraydf - :members: __init__ - -.. autoclass:: galpy.df.fardal15spraydf - :members: __init__ diff --git a/doc/source/reference/streamspraydfchen24.rst b/doc/source/reference/streamspraydfchen24.rst new file mode 100644 index 000000000..26fb8136f --- /dev/null +++ b/doc/source/reference/streamspraydfchen24.rst @@ -0,0 +1,5 @@ +The particle-spray stream DF using Chen et al. (2024) formalism +=============================================================== + +.. autoclass:: galpy.df.chen24spraydf + :members: __init__ diff --git a/doc/source/reference/streamspraydffardal15.rst b/doc/source/reference/streamspraydffardal15.rst new file mode 100644 index 000000000..0187ab21c --- /dev/null +++ b/doc/source/reference/streamspraydffardal15.rst @@ -0,0 +1,7 @@ +.. _api_streamspraydf: + +The particle-spray stream DF using Fardal et al. (2015) formalism +================================================================== + +.. autoclass:: galpy.df.fardal15spraydf + :members: __init__ diff --git a/doc/source/streamdf.rst b/doc/source/streamdf.rst index 815e7ae40..174875ccb 100644 --- a/doc/source/streamdf.rst +++ b/doc/source/streamdf.rst @@ -525,8 +525,8 @@ we give a simple example of the the two methods. .. note:: ``fardal15spraydf`` was previously known as ``streamspraydf`` before - version ``v1.10.1``. While the old name is still supported for backward - compatibility, it is recommended to use the new name ``fardal15spraydf``. + version ``v1.10.1``. While the old name is still supported until ``v.1.11.0`` + for backward compatibility, we recommend using the new name ``fardal15spraydf``. Like in the ``streamdf`` example above, we use the same orbit, potential, and cluster mass as in diff --git a/galpy/df/streamspraydf.py b/galpy/df/streamspraydf.py index 2413e3002..e60ebb7f0 100644 --- a/galpy/df/streamspraydf.py +++ b/galpy/df/streamspraydf.py @@ -392,8 +392,8 @@ def __init__( vo=None, ): """ - Initialize a Chen+24 stream spray DF model of a tidal stream - https://ui.adsabs.harvard.edu/abs/2024arXiv240801496C/abstract + Initialize a `Chen et al. (2024) `_ stream spray DF model of a tidal stream. + Parameters ---------- @@ -530,8 +530,8 @@ def __init__( vo=None, ): """ - Initialize a Fardal+15 stream spray DF model of a tidal stream - https://ui.adsabs.harvard.edu/abs/2014arXiv1410.1861F/abstract + Initialize a `Fardal et al. (2015) `_ stream spray DF model of a tidal stream. + Parameters ----------