.. image:: https://gwpy.github.io/images/gwpy_docs_1200.png

.. title:: Docs

GWpy is a collaboration-driven `Python <http://www.python.org>`_ package
providing tools for studying data from ground-based gravitational-wave
detectors.

GWpy provides a user-friendly, intuitive interface to the common time-domain
and frequency-domain data produced by the `LIGO <http://www.ligo.org>`_ and
`Virgo <http://www.ego-gw.it>`_ instruments and their analysis,
with easy-to-follow tutorials at each step.

First steps
~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   What is GWpy? <overview>
   How do I install GWpy? <install>

Working with data
~~~~~~~~~~~~~~~~~

**Working with interferometer data**

.. toctree::
   :maxdepth: 2

   timeseries/index
   signal/index

**Working with state information and segments**

.. toctree::
   :maxdepth: 2

   segments/index
   timeseries/statevector

**Working with frequency-domain data**

.. toctree::
   :maxdepth: 1

   spectrum/index
   spectrogram/index

**Visualising data**

.. toctree::
   :maxdepth: 1

   plotter/index
   cli/index

.. ----------------------------------------------------------------
.. other sections (not directly linked, but need for cross-linking)

.. toctree::
   :hidden:

   examples/index

Indices and tables
~~~~~~~~~~~~~~~~~~

.. toctree::

* :ref:`genindex`