.. Interferopy documentation master file, created by
   sphinx-quickstart on Fri Aug  6 11:51:48 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Interferopy's documentation!
***************************************

A Python library of common tasks used in the observational radio/mm interferometry data analysis.

The package was developed to aid in the studies of the interstellar medium in high-redshift quasar host galaxies using emission lines, as well as to create publication quality plots.

The package has been tested and used for ALMA, NOEMA, VLA and JCMT (limited) data.

To get started, checkout the :doc:`pages/install` page.


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

   pages/install
   pages/working-cube
   pages/tools
   pages/plots
   pages/findclumps
   pages/api

Please report any issues on the development page: https://github.com/interferopy/interferopy

Acknowledgement
===============

If you make use of Intereropy in your work, please cite it as:
*Boogaard, Meyer & Novak (2021)*, using the following BibTeX entry:

.. code-block:: none

    @software{interferopy,
    author = {Boogaard, Leindert and Meyer, Romain A. and Novak, Mladen},
    doi = {10.5281/ZENODO.5775603},
    keywords = {astronomy,interferometry,python},
    month = {dec},
    title = {{Interferopy: analysing datacubes from radio-to-submm observations}},
    url = {https://doi.org/10.5281/ZENODO.5775603},
    year = {2021}
    }


Cheers!
=======
Enjoy one pisco coctail, surrounded by dust, bubbling with CO, and with a twist of CNO elements!

.. image:: ../examples/thumbnails/pisco.png


Licence
=======
MIT License, Copyright (c) 2024 Leindert Boogaard, Romain Meyer, Mladen Novak