gwkokab.cosmology
=================

.. py:module:: gwkokab.cosmology

.. autoapi-nested-parse::

   Cosmology module for GWKokab, adapted from code written by
   `Reed Essick <https://orcid.org/0000-0001-8196-9267>`_ included in the
   `gw-distributions <https://git.ligo.org/reed.essick/gw-distributions>`_ package at
   `source <https://git.ligo.org/reed.essick/gw-distributions/-/blob/master/gwdistributions/utils/cosmology.py>`_.



Classes
-------

.. autoapisummary::

   gwkokab.cosmology.Cosmology


Functions
---------

.. autoapisummary::

   gwkokab.cosmology.PLANCK_2013_Cosmology
   gwkokab.cosmology.PLANCK_2015_Cosmology
   gwkokab.cosmology.PLANCK_2018_Cosmology
   gwkokab.cosmology.default_cosmology


Package Contents
----------------

.. py:class:: Cosmology(Ho: jaxtyping.ArrayLike, omega_matter: jaxtyping.ArrayLike, omega_radiation: jaxtyping.ArrayLike, omega_lambda: jaxtyping.ArrayLike, max_z: float = 4.0, dz: float = 0.001)

   Bases: :py:obj:`equinox.Module`


   Flat ΛCDM cosmology with Mpc-based units for distances and comoving volumes.

   Initialize the cosmology with given parameters.

   :param Ho: Hubble constant in m/s/Mpc.
   :type Ho: ArrayLike
   :param omega_matter: Matter density parameter (Ω_m).
   :type omega_matter: ArrayLike
   :param omega_radiation: Radiation density parameter (Ω_r).
   :type omega_radiation: ArrayLike
   :param omega_lambda: Dark energy density parameter (Ω_Λ).
   :type omega_lambda: ArrayLike
   :param max_z: Maximum redshift to consider, by default 4.0
   :type max_z: float, optional
   :param dz: Redshift bin width, by default DEFAULT_DZ
   :type dz: float, optional


   .. py:method:: DL_to_z(DL: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike

      Approximate inversion DL -> z using precomputed grid.



   .. py:method:: dDLdz(z: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike

      Derivative of luminosity distance with respect to redshift.



   .. py:method:: dDcdz(z: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike


   .. py:method:: dVcdz(z: jaxtyping.ArrayLike, Dc: Optional[jaxtyping.ArrayLike] = None) -> jaxtyping.ArrayLike


   .. py:method:: logdVcdz(z: jaxtyping.ArrayLike, Dc: Optional[jaxtyping.ArrayLike] = None) -> jaxtyping.ArrayLike


   .. py:method:: z_to_DL(z: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike

      Luminosity distance in Mpc.



   .. py:method:: z_to_Dc(z: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike

      Fast JAX-safe interpolation of comoving distance.



   .. py:method:: z_to_E(z: jaxtyping.ArrayLike) -> jaxtyping.ArrayLike


   .. py:property:: DL
      :type: jaxtyping.ArrayLike



   .. py:property:: Dc
      :type: jaxtyping.ArrayLike



   .. py:attribute:: Ho
      :type:  jaxtyping.ArrayLike


   .. py:attribute:: OmegaKappa
      :type:  jaxtyping.ArrayLike


   .. py:attribute:: OmegaLambda
      :type:  jaxtyping.ArrayLike


   .. py:attribute:: OmegaMatter
      :type:  jaxtyping.ArrayLike


   .. py:attribute:: OmegaRadiation
      :type:  jaxtyping.ArrayLike


   .. py:attribute:: Vc
      :type:  jaxtyping.ArrayLike


   .. py:property:: z
      :type: jaxtyping.ArrayLike



.. py:function:: PLANCK_2013_Cosmology() -> gwkokab.cosmology._cosmology.Cosmology

.. py:function:: PLANCK_2015_Cosmology() -> gwkokab.cosmology._cosmology.Cosmology

   Cosmology: See Table 4 in arXiv:1502.01589, OmegaMatter from astropy Planck
   2015.


.. py:function:: PLANCK_2018_Cosmology() -> gwkokab.cosmology._cosmology.Cosmology

   Cosmology: See Table 1 in arXiv:1807.06209.


.. py:function:: default_cosmology() -> gwkokab.cosmology._cosmology.Cosmology

   Returns the default cosmology based on GWKOKAB_DEFAULT_COSMOLOGY.