API reference
=============

Reference documentation generated from the docstrings of the ``cosmicjellyfish``
package. For a guided introduction, see :doc:`../getting_started` and
:doc:`../user_guide`.

Most users only need three modules:

- :mod:`cosmicjellyfish.fishermatrix.cosmicfish`: ``FisherMatrix``, which runs a
  forecast.
- :mod:`cosmicjellyfish.configs.config`: the options that control a forecast.
- :mod:`cosmicjellyfish.analysis.fisher_plotting`: triangle plots of Fisher matrices.

The full package tree follows. Also see the :ref:`modindex`.

.. autosummary::
   :toctree: generated
   :recursive:
   :template: autosummary/module.rst

   cosmicjellyfish.analysis
   cosmicjellyfish.CMBsurvey
   cosmicjellyfish.configs
   cosmicjellyfish.cosmology
   cosmicjellyfish.fishermatrix
   cosmicjellyfish.likelihood
   cosmicjellyfish.LSSsurvey
   cosmicjellyfish.utilities