From 6fd1b0b94a7451e4d167daadc34f7a0ccaf8b3d1 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 12:38:49 -0700 Subject: [PATCH 1/5] add LVK listings --- docs/source/listings.rst | 46 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/source/listings.rst b/docs/source/listings.rst index f31c331..a163275 100644 --- a/docs/source/listings.rst +++ b/docs/source/listings.rst @@ -125,3 +125,49 @@ Cloud Storage Buckets including image cutouts and metadata. Each alert is stored as a separate Avro file. The filename syntax is: `//.avro`. Equivalent buckets exist for previous schema versions: v3_3, v3_1, v3_0, v1_8. + +.. _data lvk: + +LIGO-Virgo-KAGRA (LVK) +------------------------------- + +:ref:`LVK ` is a gravitational wave collaboration producing an alert stream at a rate of 50 - 100 per day. + +Pub/Sub Alert Streams +^^^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :class: tight-table + :widths: 25 75 + :header-rows: 1 + + * - Topic + - Description + + * - .. centered:: *Data Streams* + - + + * - lvk-alerts + - LVK alert stream in Pub/Sub. + Messages contain the original alert bytes and metadata. + + * - lvk-BigQuery + - One message per alert indicating that the alert data is available in a BigQuery table. + Table names and alert metadata are in the message attributes. Messages contain no data. + +BigQuery Tables +^^^^^^^^^^^^^^^ + +.. list-table:: + :class: tight-table + :widths: 15 15 70 + :header-rows: 1 + + * - Dataset + - Table + - Description + + * - lvk + - alerts_O4 + - Alert data from the LVK O4 observing run. This table is an archive of the lvk-alerts Pub/Sub stream. + It has the same schema as the original alert bytes, including nested and repeated fields. From 9b4a6110c239fe9a4ac73f150db8e9e391e5d37f Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 12:39:16 -0700 Subject: [PATCH 2/5] add LVK survey page --- docs/source/surveys/index.rst | 1 + docs/source/surveys/lvk.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/source/surveys/lvk.rst diff --git a/docs/source/surveys/index.rst b/docs/source/surveys/index.rst index 0e7fc01..4e700c6 100644 --- a/docs/source/surveys/index.rst +++ b/docs/source/surveys/index.rst @@ -9,3 +9,4 @@ Note that data products may be served in multiple formats -- a complete listing :maxdepth: 1 ztf + lvk diff --git a/docs/source/surveys/lvk.rst b/docs/source/surveys/lvk.rst new file mode 100644 index 0000000..421381b --- /dev/null +++ b/docs/source/surveys/lvk.rst @@ -0,0 +1,17 @@ +.. _survey lvk: + +LIGO-Virgo-KAGRA (LVK) +====================== + +LIGO-Virgo-KAGRA is a collaboration between three gravitational wave observatories. +It produces an alert stream of gravitational wave candidates at a rate of 50 - 100 per day. + +Collaboration resources: + +- `LIGO Homepage `__ +- `Virgo Homepage `__ +- `KAGRA Homepage `__ + +Data products: + +- Alert Stream. Complete documentation can be found at ``__. From b5bdc9ed5fd7492f02d86a05ef0f48fdb075d764 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 12:39:31 -0700 Subject: [PATCH 3/5] update CHANGELOG --- CHANGELOG.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 594a312..c5d0c95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## \[Unreleased\] -(none) +### Added + +- Add 'Surveys' documentation section with pages for ZTF and LVK. +- Add LVK to Data Listings page. + +### Changed + +- Reorganize and update data listings. ## \[v0.3.10\] - 2024-07-22 From 335011d2d1aaec9ee79758b54eed78c5e1ecaa3b Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 12:52:23 -0700 Subject: [PATCH 4/5] move surveys in toctree --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index eb1ab1f..9287f21 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,9 +18,9 @@ If you run into trouble, please :maxdepth: 1 listings + surveys/index one-time-setup/index faq/index - surveys/index for-developers/index .. toctree:: From af7636a8cad7f57b1381486ef18ec3cb034ddced Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 12:52:53 -0700 Subject: [PATCH 5/5] remove sphinx.ext.autosectionlabel --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9f0ff9f..2d97735 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -45,7 +45,7 @@ "sphinx_copybutton", # [FIXME] do we really need these? # "sphinx_autodoc_typehints", # causes error can't resolve forward reference - "sphinx.ext.autosectionlabel", + # "sphinx.ext.autosectionlabel", # does not allow duplicate headings on listings.rst "sphinx.ext.mathjax", ] @@ -53,7 +53,7 @@ typehints_defaults = "braces" # adds (default: ...) after the type # Make sure the target is unique -autosectionlabel_prefix_document = True +# autosectionlabel_prefix_document = True # now can reference pages with :ref:`{path/to/page}:{title-of-section}` # but can't use this with custom labels, so # autosectionlabel_prefix_document = False