Project Notes
=============

This directory contains various project documents and notes for use by
the developers early in the project.

Directory Table of Contents
----------------------------

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: All Notes

   *
   */*

External Links and Resources
----------------------------

General
^^^^^^^

-  Project notes: `here <./notes/>`__
-  Online LSST forum for data managment (DM):
   `community.lsst.org/ <https://community.lsst.org/>`__
-  LSST-DESC Broker Workshop talks
   `drive.google.com/... <https://drive.google.com/drive/folders/1sjYXbdwTID3VnzZNAkcjLbjRfpwNaO_n?usp=sharing>`__

LSST Documents
^^^^^^^^^^^^^^

-  Plans and Policies for alert distribution (how will community brokers
   be chosen?): `ls.st/LDM-612 <https://ls.st/LDM-612>`__
-  Call for letters ofiIntent for community alert brokers (how do I
   apply to be a community broker?):
   `ls.st/LDM-682 <https://ls.st/LDM-682>`__
-  LSST alerts: key numbers (how many? how much? how often?):
   `dmtn-102.lsst.io <https://dmtn-102.lsst.io>`__
-  Data Products Definition Document (DPDD) (What data will LSST
   deliver?): `ls.st/dpdd <https://ls.st/dpdd>`__
-  Prototype schemas:
   `github.com/lsst-dm/sample-avro-alert <https://github.com/lsst-dm/sample-avro-alert>`__
-  Kafka-based alert stream:
   `github.com/lsst-dm/alert_stream <https://github.com/lsst-dm/alert_stream>`__

ZTF
^^^

-  Sample alert packets:
   `ztf.uw.edu/alerts/public/ <https://ztf.uw.edu/alerts/public/>`__
-  Alert packet tools: `zwicky.tf/4t5 <https://zwicky.tf/4t5>`__
-  Alert schema documentation: `zwicky.tf/dm5 <https://zwicky.tf/dm5>`__
-  Detailed pipelines documentation:
   `zwicky.tf/ykv <https://zwicky.tf/ykv>`__
-  PASP instrument papers: `zwicky.tf/3w9 <https://zwicky.tf/3w9>`__

Internal Resources
------------------

-  Meeting minutes: `Available on Google
   Docs <https://docs.google.com/document/d/1h6rNfFttoCKtpXUHnEfWOhzgjI6sxuSPmpTmzpz5qvw/edit#heading=h.44dh10bplhuh>`__.

-  Letter of Intent (LOI): `Available on
   Overleaf <https://www.overleaf.com/project/5c86ae8f6183b337fc5c9ec9>`__

-  Competitive products survey:

   -  `ANTARES.md <./competitive_product_survey/ANTARES.md>`__
   -  `Lasair.md <./competitive_product_survey/Lasair.md>`__

-  Notes from the DESC broker workshop:
   `desc_broker_workshop.md <desc_broker_workshop.md>`__

-  Cross matching: `cross_matching.md <./cross_matching.md>`__

-  Tutorial to setting up Cloud Pub/Sub:
   `pubsub-tutorial.md <./pubsub-tutorial.md>`__