Skip to content

Commit

Permalink
Add new Schwarzschild DF to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jobovy committed Sep 17, 2017
1 parent 6c351fd commit e1c96eb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
17 changes: 12 additions & 5 deletions doc/source/basic_df.rst
Expand Up @@ -14,12 +14,19 @@ Types of disk distribution functions
---------------------------------------

galpy contains the following distribution functions for razor-thin
disks: ``galpy.df.dehnendf`` and ``galpy.df.shudf``. These are the
distribution functions of Dehnen (`1999AJ....118.1201D
<http://adsabs.harvard.edu/abs/1999AJ....118.1201D>`_) and Shu
disks: ``galpy.df.dehnendf``, ``galpy.df.shudf``, and
``galpy.df.schwarzschilddf``. These are the distribution functions of
Dehnen (`1999AJ....118.1201D
<http://adsabs.harvard.edu/abs/1999AJ....118.1201D>`_), Shu
(`1969ApJ...158..505S
<http://adsabs.harvard.edu/abs/1969ApJ...158..505S>`_). Everything
shown below for ``dehnendf`` can also be done for ``shudf``.
<http://adsabs.harvard.edu/abs/1969ApJ...158..505S>`_), and
Schwarzschild (the Shu DF in the epicycle approximation, see Binney &
Tremaine 2008). Everything shown below for ``dehnendf`` can also be
done for ``shudf`` and ``schwarzschilddf``. The Schwarzschild DF is
primarily included as an educational tool; it is *not* a true
steady-state DF, because it uses the approximate energy from the
epicycle approximation rather than the true energy, and is fully
superseded by the Shu DF, which *is* a good steady-state DF.

These disk distribution functions are functions of the energy and the
angular momentum alone. They can be evaluated for orbits, or for a
Expand Down
1 change: 1 addition & 0 deletions doc/source/reference/df.rst
Expand Up @@ -66,6 +66,7 @@ Specific distribution functions
:maxdepth: 2

Dehnen DF <dfdehnen.rst>
Schwarzschild DF <dfschwarzschild.rst>
Shu DF <dfshu.rst>


Expand Down
5 changes: 5 additions & 0 deletions doc/source/reference/dfschwarzschild.rst
@@ -0,0 +1,5 @@
Schwarzschild DF
================

.. autoclass:: galpy.df.schwarzschilddf
:members: __init__

0 comments on commit e1c96eb

Please sign in to comment.