From a7dc1242702500636a0becb4a04c7b0b0fb9d943 Mon Sep 17 00:00:00 2001 From: "Bill Chen (Mac)" Date: Tue, 6 Aug 2024 11:55:54 -0400 Subject: [PATCH] Update documentation --- CHANGES.rst | 2 ++ docs/dynamics/mockstreams.rst | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 320134df..968d6993 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -9,6 +9,8 @@ New Features - Added the Burkert potential as a built-in cpotential. +- Added new particle spary method by Chen et al. (2024). + Bug fixes --------- diff --git a/docs/dynamics/mockstreams.rst b/docs/dynamics/mockstreams.rst index cfcbf4d6..86b0996b 100644 --- a/docs/dynamics/mockstreams.rst +++ b/docs/dynamics/mockstreams.rst @@ -65,8 +65,9 @@ We now have to specify the method for generating stream particles, i.e., the stream distribution function (DF). For this example, we will use the method implemented in [fardal15]_, incuded in ``gala`` as `~gala.dynamics.mockstream.FardalStreamDF`. Other methods of note are -`~gala.dynamics.mockstream.StreaklineStreamDF` from [kuepper12]_, and -`~gala.dynamics.mockstream.LagrangeCloudStreamDF` based on [gibbons14]_. Each of +`~gala.dynamics.mockstream.StreaklineStreamDF` from [kuepper12]_, +`~gala.dynamics.mockstream.LagrangeCloudStreamDF` based on [gibbons14]_, and +`~gala.dynamics.mockstream.ChenStreamDF` based on [chen24]_. Each of the ``StreamDF`` classes take a few common arguments, such as ``lead`` and ``trail``, which are boolean arguments that control whether to generate both leading and trailing tails, or just one or the other. By default, both are set @@ -245,6 +246,7 @@ References .. [fardal15] `Fardal, Huang, Weinberg (2015) `_ .. [kuepper12] `Küpper, Lane, Heggie (2012) `_ .. [gibbons14] `Gibbons et al. (2014) `_ +.. [chen24] `Chen et al. (2024) `_ API ---