Argus
=====

.. image:: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
   :width: 24px
   :target: https://github.com/tomkimpson/Argus
   :alt: GitHub Repo

Welcome to the **Argus** project documentation.

**Argus** is a research project for the `detection of nHz gravitational waves <https://arxiv.org/abs/2105.13270>`_ using Pulsar Timing Arrays (PTAs), leveraging a `state-space representation <https://en.wikipedia.org/wiki/State-space_representation>`_.

It is an ongoing effort to open-source methods developed at the `University of Melbourne <https://github.com/UniMelb-NSGW>`_ and `OzGrav <https://www.ozgrav.org>`_. For the accompanying papers please see:

- `Kimpson et al. 2024a <https://arxiv.org/abs/2409.14613>`_
- `Kimpson et al. 2024b <https://arxiv.org/abs/2410.10087>`_
- `Kimpson et al. 2025 <https://arxiv.org/abs/2501.06990>`_

About this Documentation
------------------------

This documentation provides an overview of the project, installation and usage instructions, API details, and developer notes for contributors.

.. note::
   If you're new to Argus, start with the "Getting Started" page in the table of contents below.

Example Usage
-------------

You can find an example of a standard PTA analysis using NANOGrav data here:

link to jupyter tutorial (TBD)...

Etymology
---------

The project is named **Argus**, after the hundred-eyed giant of Greek mythology.

> In a pulsar timing array, multiple pulsars across the sky act as a network of cosmic "eyes", continuously watching for gravitational waves.

----

.. toctree::
   :caption: Table of Contents
   :maxdepth: 3

   Getting Started <content/getting_started>
   State-Space Methods <content/state_space>
   API Documentation <_apidoc/tkimpson_2025a>
   Contributing <content/contributing>

Index
=====

* :ref:`genindex`
* :ref:`modindex`