User guide
==========

``ps_eor`` covers several related but independently useful areas of 21-cm
analysis. The pages below are organized by topic: use only the part relevant
to your work. Exact signatures and complete member lists are kept in the
:doc:`API reference <../api/index>`.

Data and preparation
--------------------

Create, inspect, combine, flag, and filter visibility data. These topics are
useful whether or not the data will later be passed to the package's
power-spectrum or signal-separation tools.

.. toctree::
   :maxdepth: 2

   data_handling
   data_quality

Power spectra
-------------

Estimate spatial, cylindrical, spherical, auto, cross, and noise-debiased
power spectra from compatible Cartesian or spherical cubes.

.. toctree::
   :maxdepth: 2

   power_spectra

Signal separation
-----------------

Use deterministic foreground models or ML-GPR posterior inference. ML-GPR has
its own set of focused pages because it includes covariance construction,
multiple inference methods, and posterior products.

.. toctree::
   :maxdepth: 2

   foreground_separation
   ml_gpr/index

Instrument and observation simulation
-------------------------------------

Model telescope sensitivity, projected UV coverage, thermal-noise power, and
power-spectrum sensitivity.

.. toctree::
   :maxdepth: 2

   observation_simulation

Spherical and wide-field data
-----------------------------

Represent wide-field observations with HEALPix maps and spherical-harmonic
coefficients, combine them, and estimate their power spectra.

.. toctree::
   :maxdepth: 2

   spherical_analysis