=========
HyperPipe
=========

.. include:: hyperpipe_intro.rst

HyperPipe is a generalized, adaptive parameter estimation pipeline. It allows for 
efficient exploration of parameter spaces by iteratively refining the 
likelihood surface.

Depending on your goal, choose the appropriate guide below:

* **New Users**: See :doc:`hyperpipe/getting_started` to run your first pipeline.
* **Power Users**: See :doc:`hyperpipe/advanced_tuning` for multi-constraint 
  inference and tracer optimizations.
* **Developers**: See :doc:`hyperpipe/driver_dev` to implement a custom 
  Marginal Driver.
* **Reference**: See :doc:`hyperpipe/reference` for input/output specifications 
  and legacy support.
* **Troubleshooting**: See :doc:`hyperpipe/troubleshooting` for diagnostic 
  commands and RIFT-specific caveats.
* **Distance grids**: See :doc:`hyperpipe/add_distance_grids` to export and
  validate per-point luminosity-distance likelihood grids.

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

   hyperpipe/getting_started
   hyperpipe/advanced_tuning
   hyperpipe/driver_dev
   hyperpipe/reference
   hyperpipe/troubleshooting
   hyperpipe/add_distance_grids