Mojito documentation
====================

We suggest to consult first the :doc:`content/installation` instructions, then
browse the :doc:`content/getting-started` guide for a quick overview of how to
download and use Mojito files.

.. image:: _static/img/flow.png
   :alt: Pour, drink and stir mojitos

But first, to get you thirsty, here is a small code snippet showcasing what
Mojito can do for you:

.. code-block:: python

   import numpy as np
   from mojito.reader import MojitoL1File
   from mojito.download import download_brick, get_source_params

   # Download Mojito L1 brick files for the source and noise
   signal_file = download_brick("mbhb", 12)
   noise_file = download_brick("noise", version=1)

   # Fetch source parameters from the catalog
   source_params = get_source_params("mbhb", 12)

   # Read the downloaded Mojito L1 files
   with MojitoL1File([signal_file, noise_file]) as f:

      # Access the first 1000 samples of XYZ TDI observables (Doppler units)
      # Datasets are automatically combined across bricks
      xyz = f.tdis.xyz_doppler[:1000]              # shape (1000, 3)

      # Access the time grid for these samples
      times = f.tdis.time_sampling.t(slice(0, 1000))  # shape (1000,)

   # Define (reception) time grid for response interpolation
   t0 = 0.0
   dt = 2.0
   time_reception = t0 + dt * np.arange(1000, dtype=float)


.. toctree::
   :hidden:

   content/installation
   content/getting-started

.. toctree::
   :caption: Pouring
   :hidden:

   content/pouring/download
   content/pouring/cli

.. toctree::
   :caption: Drinking
   :hidden:

   content/drinking/reader
   content/drinking/sampling
   content/drinking/lazy
   content/drinking/utils

.. toctree::
   :caption: Stirring
   :hidden:

   content/stirring/writer

.. toctree::
   :caption: Others
   :hidden:

   content/bibliography
   content/citing
   content/license