Move information to the docs

Signed-off-by: nstarman <[email protected]>

Author: nstarman

astropy/cosmology/parameters.py

@@ -2,58 +2,7 @@
 """This module contains dictionaries with sets of parameters for a
 given cosmology.
 
-Each cosmology has the following parameters defined:
-
-    ==========  =====================================
-    Oc0         Omega cold dark matter at z=0
-    Ob0         Omega baryon at z=0
-    Om0         Omega matter at z=0
-    flat        Is this assumed flat?  If not, Ode0 must be specified
-    Ode0        Omega dark energy at z=0 if flat is False
-    H0          Hubble parameter at z=0 in km/s/Mpc
-    n           Density perturbation spectral index
-    Tcmb0       Current temperature of the CMB
-    Neff        Effective number of neutrino species
-    m_nu        Assumed mass of neutrino species, in eV.
-    sigma8      Density perturbation amplitude
-    tau         Ionisation optical depth
-    z_reion     Redshift of hydrogen reionisation
-    t0          Age of the universe in Gyr
-    reference   Reference for the parameters
-    ==========  =====================================
-
-The list of cosmologies available are given by the tuple
-`available`. Current cosmologies available:
-
-Planck 2018 (Planck18) parameters from Planck Collaboration 2020,
- A&A, 641, A6 (Paper VI), Table 2 (TT, TE, EE + lowE + lensing + BAO)
-
-Planck 2015 (Planck15) parameters from Planck Collaboration 2016, A&A, 594, A13
- (Paper XIII), Table 4 (TT, TE, EE + lowP + lensing + ext)
-
-Planck 2013 (Planck13) parameters from Planck Collaboration 2014, A&A, 571, A16
- (Paper XVI), Table 5 (Planck + WP + highL + BAO)
-
-WMAP 9 year (WMAP9) parameters from Hinshaw et al. 2013, ApJS, 208, 19,
-doi: 10.1088/0067-0049/208/2/19. Table 4 (WMAP9 + eCMB + BAO + H0)
-
-WMAP 7 year (WMAP7) parameters from Komatsu et al. 2011, ApJS, 192, 18,
-doi: 10.1088/0067-0049/192/2/18. Table 1 (WMAP + BAO + H0 ML).
-
-WMAP 5 year (WMAP5) parameters from Komatsu et al. 2009, ApJS, 180, 330,
-doi: 10.1088/0067-0049/180/2/330. Table 1 (WMAP + BAO + SN ML).
-
-WMAP 3 year (WMAP3) parameters from Spergel et al. 2007, ApJS, 170, 377,
-doi:  10.1086/513700. Table 6. (WMAP + SNGold) Obtained from
-https://lambda.gsfc.nasa.gov/product/map/dr2/params/lcdm_wmap_sngold.cfm
-Tcmb0 and Neff are the standard values as also used for WMAP5, 7, 9.
-Pending WMAP team approval and subject to change.
-
-WMAP 1 year (WMAP1) parameters from Spergel et al. 2003, ApJS, 148, 175,
-doi:  10.1086/377226. Table 7 (WMAP + CBI + ACBAR + 2dFGRS + Lya)
-Tcmb0 and Neff are the standard values as also used for WMAP5, 7, 9.
-Pending WMAP team approval and subject to change.
-
+The list of cosmologies available are given by the tuple `available`.
 """
 
 # STDLIB

astropy/cosmology/realizations.py

@@ -1,5 +1,7 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
 
+"""Preloaded cosmologies. See ``available``."""
+
 __all__ = [  # noqa: F822 (undefined name)
     "available",
     "default_cosmology",

docs/common_links.txt

@@ -29,7 +29,14 @@
 .. |LambdaCDM| replace:: :class:`~astropy.cosmology.LambdaCDM`
 .. |FlatLambdaCDM| replace:: :class:`~astropy.cosmology.FlatLambdaCDM`
 
-.. |Planck18| replace:: :ref:`Planck18 <astropy:Planck18>`
+.. |WMAP1| replace:: :ref:`astropy_cosmology_realizations_WMAP1`
+.. |WMAP3| replace:: :ref:`astropy_cosmology_realizations_WMAP3`
+.. |WMAP5| replace:: :ref:`astropy_cosmology_realizations_WMAP5`
+.. |WMAP7| replace:: :ref:`astropy_cosmology_realizations_WMAP7`
+.. |WMAP9| replace:: :ref:`astropy_cosmology_realizations_WMAP9`
+.. |Planck13| replace:: :ref:`astropy_cosmology_realizations_Planck13`
+.. |Planck15| replace:: :ref:`astropy_cosmology_realizations_Planck15`
+.. |Planck18| replace:: :ref:`astropy_cosmology_realizations_Planck18`
 
 .. |FlatCosmologyMixin| replace:: :class:`~astropy.cosmology.FlatCosmologyMixin`
 .. |FlatFLRWMixin| replace:: :class:`~astropy.cosmology.FlatFLRWMixin`

docs/cosmology/index.rst

@@ -9,10 +9,6 @@ Cosmological Calculations (`astropy.cosmology`)
 .. |w0wzCDM| replace:: :class:`~astropy.cosmology.w0wzCDM`
 .. |w0waCDM| replace:: :class:`~astropy.cosmology.w0waCDM`
 .. |wpwaCDM| replace:: :class:`~astropy.cosmology.wpwaCDM`
-.. |WMAP7| replace:: :ref:`WMAP7 <astropy:WMAP7>`
-.. |WMAP9| replace:: :ref:`WMAP9 <astropy:WMAP9>`
-.. |Planck13| replace:: :ref:`Planck13 <astropy:Planck13>`
-.. |Planck15| replace:: :ref:`Planck15 <astropy:Planck15>`
 .. |z_at_value| replace:: :func:`~astropy.cosmology.z_at_value`
 
 Introduction
@@ -24,6 +20,9 @@ depend on a cosmological model. This includes distances, ages, and lookback
 times corresponding to a measured redshift or the transverse separation
 corresponding to a measured angular separation.
 
+A number of preloaded cosmologies are available from analyses using
+the WMAP and Planck satellite data. See :ref:`astropy-cosmology-realizations`.
+
 :mod:`astropy.cosmology.units` extends the :mod:`astropy.units` sub-package,
 adding and collecting cosmological units and equivalencies, like :math:`h` for
 keeping track of (dimensionless) factors of the Hubble constant.
@@ -108,8 +107,9 @@ Using `astropy.cosmology`
 More detailed information on using the package is provided on separate pages,
 listed below.
 
-* :ref:`cosmology_io`
+* :ref:`astropy-cosmology-realizations`
 * :ref:`Units and Equivalencies <astropy-cosmology-units-and-equivalencies>`
+* :ref:`cosmology_io`
 * :ref:`For Developers <astropy-cosmology-for-developers>`
 
 Most of the functionality is enabled by the |FLRW| object. This represents a
@@ -306,39 +306,8 @@ the WMAP and Planck satellite data. For example:
   >>> Planck13.lookback_time(2)  # lookback time in Gyr at z=2  # doctest: +FLOAT_CMP
   <Quantity 10.51184138 Gyr>
 
-A full list of the predefined cosmologies is given by
-``cosmology.realizations.available`` and summarized below:
-
-===========  ============================== ====  ===== =======
-Name         Source                         H0    Om    Flat
-===========  ============================== ====  ===== =======
-_`WMAP1`     Spergel et al. 2003            72.0  0.257 Yes
-_`WMAP3`     Spergel et al. 2007            70.1  0.276 Yes
-_`WMAP5`     Komatsu et al. 2009            70.2  0.277 Yes
-_`WMAP7`     Komatsu et al. 2011            70.4  0.272 Yes
-_`WMAP9`     Hinshaw et al. 2013            69.3  0.287 Yes
-_`Planck13`  Planck Collab 2013, Paper XVI  67.8  0.307 Yes
-_`Planck15`  Planck Collab 2015, Paper XIII 67.7  0.307 Yes
-_`Planck18`  Planck Collab 2018, Paper VI   67.7  0.310 Yes
-===========  ============================== ====  ===== =======
-
-.. note::
-
-  Unlike the Planck 2015 paper, the Planck 2018 paper includes massive
-  neutrinos in ``Om0`` but the Planck18 object includes them in ``m_nu``
-  instead for consistency. Hence, the ``Om0`` value in Planck18 differs
-  slightly from the Planck 2018 paper but represents the same cosmological
-  model.
-
-Currently, all are instances of |FlatLambdaCDM|. More details about exactly
-where each set of parameters comes from are available in the docstring for each
-object::
-
-  >>> from astropy.cosmology import WMAP7
-  >>> print(WMAP7.__doc__)
-  WMAP7 instance of FlatLambdaCDM cosmology
-  (from Komatsu et al. 2011, ApJS, 192, 18, doi: 10.1088/0067-0049/192/2/18.
-   Table 1 (WMAP + BAO + H0 ML).)
+A full list of the predefined cosmologies can be found in
+:ref:`astropy-cosmology-realizations`.
 
 
 Specifying a Dark Energy Model
@@ -510,7 +479,8 @@ Reference/API
 .. toctree::
    :maxdepth: 2
 
-   io/index
+   realizations
    Units and Equivalencies <units>
+   io/index
    For Developers <dev>
    ref_api