Skip to content
GitLab
Commit ec710c36 authored by Leo P. Singer's avatar Leo P. Singer
Browse files

Rename to LIGO/Virgo/KAGRA Public Alerts User Guide 

Fixes #271.
parent 8ea744a0
Pipeline #424496 failed with stage
in 5 minutes and 34 seconds
Hide whitespace changes
Inline Side-by-side
.gitlab-ci.yml
View file @ ec710c36
......@@ -69,7 +69,7 @@ latexpdf:
expose_as: pdf
expire_in: 2 weeks # P&P circulation period
paths:
- latex/LIGOVirgoPublicAlertsUserGuide.pdf
- latex/LIGOVirgoKAGRAPublicAlertsUserGuide.pdf
linkcheck:
<<: *sphinx
......@@ -96,7 +96,7 @@ pages:
stage: deploy
script:
- mv html public/
- mv latex/LIGOVirgoPublicAlertsUserGuide.pdf public/
- mv latex/LIGOVirgoKAGRAPublicAlertsUserGuide.pdf public/
artifacts:
paths:
- public
......
Makefile
View file @ ec710c36
......@@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = LIGOVirgoPublicAlertsUserGuide
SPHINXPROJ = LIGOVirgoKAGRAPublicAlertsUserGuide
SOURCEDIR = .
BUILDDIR = _build
......
README.rst
View file @ ec710c36
LIGO/Virgo Public Alerts User Guide
===================================
LIGO/Virgo/KAGRA Public Alerts User Guide
=========================================
This Git repository contains the source code for the LIGO/Virgo Public Alerts
User Guide. For most recently released HTML edition of the User Guide, visit
http://emfollow.docs.ligo.org/.
This Git repository contains the source code for the LIGO/Virgo/KAGRA Public
Alerts User Guide. For most recently released HTML edition of the User Guide,
visit http://emfollow.docs.ligo.org/.
We welcome feedback and suggestions. To report an issue related to the User
Guide, please send an e-mail to emfollow-userguide@support.ligo.org.
......@@ -75,12 +75,12 @@ When you are ready to publish a new version, follow these steps:
5. **Send an announcement to the OpenLVEM list.** Compose an email starting
from `a recent example`_ or from the template below:
Subject: Announcing version *NN* of the LIGO/Virgo Public Alerts User
Guide, including *BRIEF PHRASE DESCRIBING MAJOR CHANGES*
Subject: Announcing version *NN* of the LIGO/Virgo/KAGRA Public Alerts
User Guide, including *BRIEF PHRASE DESCRIBING MAJOR CHANGES*
Dear colleagues,
We made some changes to the LIGO/Virgo Public Alerts User Guide
We made some changes to the LIGO/Virgo/KAGRA Public Alerts User Guide
(https://emfollow.docs.ligo.org/). The most significant update is *A
FEW WORDS CALLING ATTENTION TO THE MOST IMPORTANT CHANGES*.
......@@ -92,7 +92,7 @@ When you are ready to publish a new version, follow these steps:
| Sincerely yours,
| *YOUR NAME HERE*
| for the LIGO and Virgo Collaborations
| for the LIGO, Virgo, and KAGRA Collaborations
|
Version *NN* (*YYYY*-*MM*-*DD*)
......
_static/MS181101ab-1-EarlyWarning.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T22:34:20</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=163 is an LVC_EARLY_WARNING notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="1">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -78,7 +78,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......@@ -97,5 +97,6 @@
<Description>H1: LIGO Hanford 4 km gravitational wave detector</Description>
<Description>L1: LIGO Livingston 4 km gravitational wave detector</Description>
<Description>V1: Virgo 3 km gravitational wave detector</Description>
<Description>K1: KAGRA 3 km gravitational wave detector</Description>
</How>
</voe:VOEvent>
_static/MS181101ab-2-Preliminary.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T22:34:49</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=150 is an LVC_PRELIMINARY notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="2">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -78,7 +78,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......@@ -97,6 +97,7 @@
<Description>H1: LIGO Hanford 4 km gravitational wave detector</Description>
<Description>L1: LIGO Livingston 4 km gravitational wave detector</Description>
<Description>V1: Virgo 3 km gravitational wave detector</Description>
<Description>K1: KAGRA 3 km gravitational wave detector</Description>
</How>
<Citations>
<EventIVORN cite="supersedes">ivo://gwnet/LVC#MS181101ab-1-EarlyWarning</EventIVORN>
......
_static/MS181101ab-3-Initial.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T22:36:25</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=151 is an LVC_INITIAL notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="3">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -78,7 +78,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......@@ -97,6 +97,7 @@
<Description>H1: LIGO Hanford 4 km gravitational wave detector</Description>
<Description>L1: LIGO Livingston 4 km gravitational wave detector</Description>
<Description>V1: Virgo 3 km gravitational wave detector</Description>
<Description>K1: KAGRA 3 km gravitational wave detector</Description>
</How>
<Citations>
<EventIVORN cite="supersedes">ivo://gwnet/LVC#MS181101ab-2-Preliminary</EventIVORN>
......
_static/MS181101ab-4-Update.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T22:36:25</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=152 is an LVC_UPDATE notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="4">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -78,7 +78,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......@@ -97,6 +97,7 @@
<Description>H1: LIGO Hanford 4 km gravitational wave detector</Description>
<Description>L1: LIGO Livingston 4 km gravitational wave detector</Description>
<Description>V1: Virgo 3 km gravitational wave detector</Description>
<Description>K1: KAGRA 3 km gravitational wave detector</Description>
</How>
<Citations>
<EventIVORN cite="supersedes">ivo://gwnet/LVC#MS181101ab-3-Initial</EventIVORN>
......
_static/MS181101ab-5-Retraction.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T23:36:23</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=164 is an LVC_RETRACTION notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="5">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -34,7 +34,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......
_static/MS181101ab-6-Update.xml
View file @ ec710c36
......@@ -3,7 +3,7 @@
<Who>
<Date>2018-11-01T22:39:25</Date>
<Author>
<contactName>LIGO Scientific Collaboration and Virgo Collaboration</contactName>
<contactName>LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration</contactName>
</Author>
</Who>
<What>
......@@ -11,7 +11,7 @@
<Description>The Notice Type number is assigned/used within GCN, eg type=152 is an LVC_UPDATE notice</Description>
</Param>
<Param dataType="int" name="internal" value="0">
<Description>Indicates whether this event should be distributed to LSC/Virgo members only</Description>
<Description>Indicates whether this event should be distributed to LSC/Virgo/KAGRA members only</Description>
</Param>
<Param dataType="int" name="Pkt_Ser_Num" value="6">
<Description>A number that increments by 1 each time a new revision is issued for this event</Description>
......@@ -99,7 +99,7 @@
</What>
<WhereWhen>
<ObsDataLocation>
<ObservatoryLocation id="LIGO Virgo"/>
<ObservatoryLocation id="LIGO Virgo KAGRA"/>
<ObservationLocation>
<AstroCoordSystem id="UTC-FK5-GEO"/>
<AstroCoords coord_system_id="UTC-FK5-GEO">
......@@ -118,6 +118,7 @@
<Description>H1: LIGO Hanford 4 km gravitational wave detector</Description>
<Description>L1: LIGO Livingston 4 km gravitational wave detector</Description>
<Description>V1: Virgo 3 km gravitational wave detector</Description>
<Description>K1: KAGRA 3 km gravitational wave detector</Description>
</How>
<Citations>
<EventIVORN cite="supersedes">ivo://gwnet/LVC#MS181101ab-5-Retraction</EventIVORN>
......
_static/bayestar.fits.gz
View file @ ec710c36
No preview for this file type
_templates/about.html
View file @ ec710c36
......@@ -5,6 +5,9 @@
<a href="http://public.virgo-gw.eu/the-virgo-collaboration/">
<img class="logo" src="{{ pathto('_static/virgo-logo.png', true) }}" alt="Virgo Collaboration logo"/>
</a>
<a href="https://gwcenter.icrr.u-tokyo.ac.jp/en/">
<img class="logo" src="{{ pathto('_static/kagra-logo.png', true) }}" alt="KAGRA Observatory logo"/>
</a>
<h1 class="logo"><a href="{{ pathto(master_doc) }}">Public Alerts User Guide</a></h1>
</p>
......
analysis/index.rst
View file @ ec710c36
......@@ -24,10 +24,10 @@ The timeline for distribution of alerts is described below.
Alert Timeline
--------------
Here, we describe the sequence of LIGO/Virgo alerts for a single event that
will be distributed through the Gamma-ray Coordinates Network (:term:`GCN`) via
notices and circulars (see the :doc:`/content` and :doc:`/tutorial/index`
sections for details).
Here, we describe the sequence of LIGO/Virgo/KAGRA alerts for a single event
that will be distributed through the Gamma-ray Coordinates
Network (:term:`GCN`) via notices and circulars (see the :doc:`/content` and
:doc:`/tutorial/index` sections for details).
.. plot::
:alt: Timeline for sending gravitational-wave alerts
......
analysis/searches.rst
View file @ ec710c36
......@@ -151,8 +151,8 @@ only timing information (temporal) and one including GRB/GW sky map information
to trigger preliminary alerts once this is finished.
**LLAMA** [#LLAMA1]_ [#LLAMA2]_ The `Low-Latency Algorithm for Multi-messenger
Astrophysics`_ is a an online search pipeline combining LIGO/Virgo GW triggers
with High Energy Neutrino (HEN) triggers from IceCube. It finds
Astrophysics`_ is a an online search pipeline combining LIGO/Virgo/KAGRA GW
triggers with High Energy Neutrino (HEN) triggers from IceCube. It finds
temporally-coincident sub-threshold IceCube neutrinos and performs a detailed
Bayesian significance calculation to find joint GW+HEN triggers.
......
capabilities.rst
View file @ ec710c36
......@@ -28,19 +28,9 @@ signals, this figure gives the BNS :term:`range` for each observing run.
.. figure:: _static/observing-scenarios-timeline.*
:alt: Long-term observing schedule
Engineering Run 14 (ER14) started on 2019-03-04. The transition into Observing
Run 3 (O3) occurred on 2019-04-01. O3 had been scheduled to end on 2020-04-30,
but was suspended early on March 27, 2020, due to the COVID-19 pandemic
[#LIGOEndingO3Observations]_. When it becomes safe to resume normal activities,
there may be a short period of additional O3 observations before an extended
shutdown to prepare for the next observing run (O4). Updates will be posted in
this document as they become available.
During O3, we expect that three facilities (:term:`LHO`, :term:`LLO`, and
Virgo) will observe for one year. It is possible that the Japanese KAGRA
detector may come online and become part of the international
gravitational-wave network at some point during O3. The near-term observing
schedule is shown below, reproduced from [#CurrentO3Schedule]_.
During O4, we expect that three facilities (:term:`LHO`, :term:`LLO`,
:term:`Virgo`, and :term:`KAGRA`) will observe for one year. The near-term
observing schedule is shown below, reproduced from [#CurrentO3Schedule]_.
.. figure:: _static/O3Schedule.*
:alt: Current observing schedule
......@@ -49,7 +39,7 @@ Live Status
-----------
There are a handful of public web pages that report live status of the
LIGO/Virgo detectors and alert infrastructure.
LIGO/Virgo/KAGRA detectors and alert infrastructure.
* | **Detector Status Portal**: Daily summary of detector performance.
| https://www.gw-openscience.org/detector_status/
......@@ -58,8 +48,8 @@ LIGO/Virgo detectors and alert infrastructure.
| https://ldas-jobs.ligo.caltech.edu/~gwistat/gwistat/gwistat.html
* | **LIGO Data Grid Status**: Live dashboard showing up/down status of the
detectors and online analyses. Status of the LIGO/Virgo alert pipeline is
indicated by the "EMFollow" box.
detectors and online analyses. Status of the LIGO/Virgo/KAGRA alert
pipeline is indicated by the "EMFollow" box.
| https://monitor.ligo.org/gwstatus
Sensitivity
......
changes.rst
View file @ ec710c36
......@@ -6,6 +6,9 @@ Version 17 (unreleased)
.. rubric:: General
* Change the name of this document from "LIGO/Virgo Public Alerts User Guide"
to "LIGO/Virgo/KAGRA Public Alerts User Guide".
.. rubric:: Getting Started Checklist
.. rubric:: Observing Capabilities
......@@ -84,8 +87,8 @@ Version 13 (2019-12-16)
.. rubric:: Alert Contents
* Add a warning that :term:`VOEvent` over anonymous :term:`VTP` is the only
GCN format and distribution method that is fully supported by LIGO/Virgo. In
particular, LIGO/Virgo performs only limited quality control control checks
GCN format and distribution method that is fully supported by LIGO/Virgo/KAGRA. In
particular, LIGO/Virgo/KAGRA performs only limited quality control control checks
for the textual "full format" and the binary format.
* In the VOEvent alert schema, add a ``name`` attribute to each ``<Group>``
......@@ -197,7 +200,7 @@ Version 10 (2019-07-31)
will also make it simpler to work with Numpy indexing operations, since Numpy
uses a signed integer type for indexing.
This change will go into effect in the LIGO/Virgo low-latency alert system on
This change will go into effect in the LIGO/Virgo/KAGRA low-latency alert system on
2019-08-06.
Users of `ligo.skymap`_ should update to version 0.1.8 or newer because older
......@@ -352,7 +355,7 @@ Version 3 (2019-02-13)
* Change the IVORN prefix from ``ivo://gwnet/gcn_sender`` to
``ivo://gwnet/LVC``, because GCN traditionally uses the text after the ``/``
to indicate the name of the mission, which most closely corresponds to "LVC,"
short for "LIGO/Virgo Collaboration." Note that this IVORN is used for
short for "LIGO/Virgo/KAGRA Collaboration." Note that this IVORN is used for
historical purposes and continuity with the GCN notice format used in O1 and
O2, and is likely to change in the future with the commissioning of
additional gravitational-wave facilities.
......@@ -379,7 +382,7 @@ Version 2 (2018-12-13)
.. rubric:: Sample Code
* GCN has now begun publicly broadcasting sample LIGO/Virgo GCN Notices.
* GCN has now begun publicly broadcasting sample LIGO/Virgo/KAGRA GCN Notices.
Updated the sample code accordingly with instructions for receiving live
sample notices.
......
conf.py
View file @ ec710c36
......@@ -22,9 +22,9 @@ from versioneer import get_version
# -- Project information -----------------------------------------------------
project = 'LIGO/Virgo Public Alerts User Guide'
copyright = '2018-2020, LIGO Scientific Collaboration, Virgo Collaboration'
author = 'LIGO Scientific Collaboration, Virgo Collaboration'
project = 'LIGO/Virgo/KAGRA Public Alerts User Guide'
copyright = '2018-2022, LIGO Scientific Collaboration, Virgo Collaboration, KAGRA Collaboration'
author = 'LIGO Scientific Collaboration, Virgo Collaboration, KAGRA Collaboration'
# The full version, including alpha/beta/rc tags
release = get_version()
......@@ -91,7 +91,7 @@ html_theme = 'alabaster'
# documentation.
#
html_theme_options = {
'description': 'Primer on public alerts for astronomers from the LIGO and Virgo gravitational-wave observatories.',
'description': 'Primer on public alerts for astronomers from the LIGO, Virgo, and KAGRA gravitational-wave observatories.',
'fixed_sidebar': True,
'show_relbars': True,
'sidebar_collapse': True
......@@ -124,7 +124,7 @@ html_sidebars = {
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'LIGOVirgoPublicAlertsUserGuidedoc'
htmlhelp_basename = 'LIGOVirgoKAGRAPublicAlertsUserGuidedoc'
# -- Options for LaTeX output ------------------------------------------------
......@@ -151,8 +151,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'LIGOVirgoPublicAlertsUserGuide.tex', project,
'LIGO Scientific Collaboration, Virgo Collaboration', 'manual'),
(master_doc, 'LIGOVirgoKAGRAPublicAlertsUserGuide.tex', project,
'LIGO Scientific Collaboration, Virgo Collaboration, KAGRA Collaboration', 'manual'),
]
latex_elements = {
......@@ -171,7 +171,7 @@ latex_elements['preamble'] = '\DeclareUnicodeCharacter{2728}{New: }'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'ligovirgopublicalertsuserguide', project,
(master_doc, 'ligovirgokagrapublicalertsuserguide', project,
[author], 1)
]
......@@ -182,8 +182,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'LIGOVirgoPublicAlertsUserGuide', project,
author, 'LIGOVirgoPublicAlertsUserGuide', 'One line description of project.',
(master_doc, 'LIGOVirgoKAGRAPublicAlertsUserGuide', project,
author, 'LIGOVirgoKAGRAPublicAlertsUserGuide', 'One line description of project.',
'Miscellaneous'),
]
......
content.rst
View file @ ec710c36
Alert Contents
==============
Public LIGO/Virgo alerts are distributing using NASA's Gamma-ray Coordinates
Network (:term:`GCN`). There are two types of alerts:
Public LIGO/Virgo/KAGRA alerts are distributing using NASA's Gamma-ray
Coordinates Network (:term:`GCN`). There are two types of alerts:
**GCN Notices** are machine-readable packets. They are available as
:term:`VOEvent` XML and `several other legacy formats`_. See the
......@@ -10,15 +10,15 @@ Network (:term:`GCN`). There are two types of alerts:
format.
.. warning::
We recommend receiving LIGO/Virgo alerts in the VOEvent XML format using one
of `GCN's anonymous VOEvent brokers`_. VOEvent over anonymous :term:`VTP` is
the **only GCN format and distribution method that is fully supported by
LIGO/Virgo.**
We recommend receiving LIGO/Virgo/KAGRA alerts in the VOEvent XML format
using one of `GCN's anonymous VOEvent brokers`_. VOEvent over anonymous
:term:`VTP` is the **only GCN format and distribution method that is fully
supported by LIGO/Virgo/KAGRA.**
The VOEvent XML alerts are official data products of LIGO/Virgo. GCN
The VOEvent XML alerts are official data products of LIGO/Virgo/KAGRA. GCN
produces `several other legacy formats`_ from them, in particular a
text-based "full format" and binary format. LIGO/Virgo performs only limited
quality control of the legacy formats.
text-based "full format" and binary format. LIGO/Virgo/KAGRA performs only
limited quality control of the legacy formats.
**GCN Circulars** are short human-readable astronomical bulletins. They are
written in a certain well-established `format and style`_. You can `subscribe
......@@ -86,7 +86,8 @@ assessment`_.
Notice Contents
---------------
The table below is a representation of the contents of a LIGO/Virgo GCN Notice.
The table below is a representation of the contents of a LIGO/Virgo/KAGRA GCN
Notice.
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
| **Root** |
......@@ -99,7 +100,7 @@ The table below is a representation of the contents of a LIGO/Virgo GCN Notice.
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
| Date | Time sent (UTC, ISO-8601), e.g. :samp:`2018-11-01T22:34:49` |
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
| Author | :samp:`LIGO Scientific Collaboration and Virgo Collaboration` |
| Author | :samp:`LIGO Scientific Collaboration, Virgo Collaboration, and KAGRA Collaboration` |
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
| **What** |
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
......@@ -138,6 +139,7 @@ The table below is a representation of the contents of a LIGO/Virgo GCN Notice.
| | :samp:`H1: LIGO Hanford 4 km gravitational wave detector`, |
| | :samp:`L1: LIGO Livingston 4 km gravitational wave detector` and |
| | :samp:`V1: Virgo 3 km gravitational wave detector` |
| | :samp:`K1: KAGRA 3 km gravitational wave detector` |
| | whose data have been used by the :doc:`online pipeline </analysis/searches>` that has produced the preferred event |
| | for that particular :doc:`superevent </analysis/superevents>` |
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
......@@ -236,9 +238,9 @@ such as ``bayestar.fits.gz``, always points to the most recent version.
rationale in :dcc:`G1800186`). It uses HEALPix :ref:`explicit indexing
<gamma-astro-data-formats:hpx_explicit>` and the `NUNIQ numbering scheme`_,
which is closely related to `multi-order coverage (MOC) maps`_ in Aladin.
This is the internal format that is used by the LIGO/Virgo low-latency
alert pipeline. **This is an experimental format, and it is currently
recommended only for advanced users.** See the section
This is the internal format that is used by the LIGO/Virgo/KAGRA
low-latency alert pipeline. **This is an experimental format, and it is
currently recommended only for advanced users.** See the section
:doc:`/tutorial/multiorder_skymaps` for details.
Both formats always use celestial (equatorial, J2000) coordinates.
......@@ -375,9 +377,9 @@ NSBH, or BBH merger):
All of the quantities in the Classification and Properties sections are model
dependent to some extent: the Classification section takes into consideration
prior knowledge of astrophysical compact binary merger rates from previous
LIGO/Virgo observations, and both the Classification and Properties sections
depend on details of neutron star physics (e.g. maximum NS mass, equation of
state). See the earlier subsection of the :doc:`Data Analysis
LIGO/Virgo/KAGRA observations, and both the Classification and Properties
sections depend on details of neutron star physics (e.g. maximum NS mass,
equation of state). See the earlier subsection of the :doc:`Data Analysis
</analysis/inference>` section for implementation details.
Circular Contents
......
glossary.rst
View file @ ec710c36
......@@ -59,7 +59,7 @@ Glossary
GraceDB
Gravitational Wave Candidate Event Database (https://gracedb.ligo.org),
the official public marshal portal for LIGO/Virgo candidates.
the official public marshal portal for LIGO/Virgo/KAGRA candidates.
GRB
Gamma-ray burst.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment