halox.lss: Large-scale structure calculations
=============================================

``halox`` provides a JAX implementation of large-scale structure calculations including RMS variance computations, mass-to-radius conversions, and overdensity transformations.
Cosmology calculations (e.g. power spectra) rely on `jax-cosmo <https://github.com/DifferentiableUniverseInitiative/jax_cosmo>`_.
For examples, see :doc:`../notebooks/lss`.

.. currentmodule:: halox.lss

.. autosummary::
    sigma_R
    sigma_M
    overdensity_c_to_m
    overdensity_m_to_c
    mass_to_lagrangian_radius
    peak_height

.. autofunction:: sigma_R
.. autofunction:: sigma_M
.. autofunction:: overdensity_c_to_m
.. autofunction:: overdensity_m_to_c
.. autofunction:: mass_to_lagrangian_radius
.. autofunction:: peak_height
