.. Pitt-Google Broker documentation master file, created by
   sphinx-quickstart on Wed Jul 28 17:34:03 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pitt-Google Broker
==============================================

The Pitt-Google Broker is a cloud-based alert distribution service designed to provide near real-time processing of data from large-scale astronomical surveys like the `Legacy Survey of Space and Time <https://www.lsst.org/>`_ (LSST). LSST will deliver on order 10 million real-time alerts each night providing information on astronomical targets within 60 seconds of observation. The Pitt-Google Broker is a scalable broker system being designed to maximize the availability and usefulness of the LSST alert data by combining cloud-based analysis opportunities with value-added data products.

The Pitt-Google Broker runs on the `Google Cloud Platform <https://cloud.google.com/>`_ (GCP) and is currently focused on processing and serving alerts from the `Zwicky Transient Facility <https://www.ztf.caltech.edu/>`_ (ZTF), and extending broker capabilities using ZTF, the LSST Alert Simulator, and the DECam Alliance for Transients (DECAT) stream.

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Broker Software

   broker/broker-overview
   broker/architecture-diagrams
   broker/broker-instance-keywords
   broker/components
   broker/setup-ref
   broker/run-a-broker-instance
   broker/alerts-for-testing
   broker/primers-for-developers

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: API Reference

   api/broker-utils/avro-schemas
   api/broker-utils/consumer-sim
   api/broker-utils/data-utils
   api/broker-utils/gcp-utils
   api/broker-utils/math
   api/broker-utils/schema-maps
   api/broker-utils/testing
   api/broker-utils/types

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Working Notes

   working-notes/early-dev/README
   working-notes/troyraen/index