.. HyRex documentation master file, created by
   sphinx-quickstart on Tue Oct  7 11:05:49 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

HyRex documentation
===================

HyRex is a fully-JAX version of HYREC-2.  It is intended to be used in conjunction with a differentiable Boltzmann solver
for the CMB such as `ABCMB <https://abcmb.readthedocs.io/en/latest/>`_, but can also be used as a standalone code.


Installation
------------
To download and install HyRex, please visit our `GitHub <https://github.com/TonyZhou729/HyRex>`_.  There you will find detailed instructions for installing HyRex and its dependencies.

Examples
--------
We include a pedagogical example `notebook <https://github.com/TonyZhou729/HyRex/blob/main/notebooks/hyrex_intro.ipynb>`_ demonstrating how to use HyRex on at our `GitHub <https://github.com/TonyZhou729/HyRex>`_. 


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules