Create notices and circulars for medium-latency GRB detections

The GRB group has requested that we support both notices (GCN, I assume Kafka as well) and circulars concerning medium-latency pipelines that follow up GRBs (could be detection or non-detection).

Circulars:

• There is currently code that produces these circulars but could be out-of-date, so need to ensure these are ready for O4 or update them accordingly (see this issues: ligo-followup-advocate#68 (closed))

Notices:

• Identify whether these notices should be created automatically or require human vetting (similar to how we send update notices via the dashboard: https://emfollow.ligo.caltech.edu/gwcelery/)
• Identify what conditions to create a notice (both detection and non-detection), i.e. what information/labels need to present in an external event or superevent to identify a notice should be sent
• Identify any additional fields or info not currently included in our alerts (both GCN and Kafka) that need to be added: https://emfollow.docs.ligo.org/userguide/content.html

---

• Once we've identified the scope, we can start to work out between external_triggers.py, alerts.py, views.py, and GraceDB what needs to be developed.

changed milestone to %O4-low-priority

added External Triggers GCN Circulars GCN Notices Kafka Alerts labels

set weight to 5

changed the description

@brandon.piotrzkowski The GRB group agreed on the following thus far, although I believe we are not ready to make the requested change to adding notices yet due to item 2.

• Identify whether these notices should be created automatically or require human vetting (similar to how we send update notices via the dashboard: https://emfollow.ligo.caltech.edu/gwcelery/)

We believe human vetted notices will be appropriate.

• Identify what conditions to create a notice (both detection and non-detection), i.e. what information/labels need to present in an external event or superevent to identify a notice should be sent

My workflow model was that a notice would only be created on a detection, and circulars are instead generated upon non-detection. The previous/current working model is that a circular is automatically generated upon a detection, which only provides the FAP information currently. Moving to a notice model, I need to learn how to upload more information to the gracedb annotations or to create an event within GraceDB as appropriate to include all of the trigger information. The current code indicates an event using this bit of code:

if type == 'EVENT':
        graceid = id
        message = 'Online PyGRB: Significant event in on-source (FAP = ' + FAP + \
                  ' for the most significant event). For full results, see <a href="https://ldas-jobs.ligo.' \
                  'caltech.edu/~' + USERNAME + '/grb/online/' + LIGORUN + '/GRB' + id + '/GRB' + id + \
                  '_OPEN/summary.html">here</a>.'
        try:
            r = gracedb.writeLog(graceid, message, tagname="ext_coinc")

• Identify any additional fields or info not currently included in our alerts (both GCN and Kafka) that need to be added: https://emfollow.docs.ligo.org/userguide/content.html

Given that the JSON allows for external_coinc information, there are no additional fields that will be needed. There is one point to consider: PyGRB triggers are essentially CBC triggers, but we do not generate any probabilities regarding the classification.

marked the checklist item There is currently code that produces these circulars but could be out-of-date, so need to ensure these are ready for O4 or update them accordingly (see this issues: ligo-followup-advocate#68 (closed)) as completed

It doesn't look like modifying the notices is doable prior to the start of O4, so moving this to a later milestone.

added to epic &8

changed milestone to %O4a mid-run release

assigned to @naresh.adhikari

marked the checklist item Identify whether these notices should be created automatically or require human vetting (similar to how we send update notices via the dashboard: https://emfollow.ligo.caltech.edu/gwcelery/) as completed

marked the checklist item Identify what conditions to create a notice (both detection and non-detection), i.e. what information/labels need to present in an external event or superevent to identify a notice should be sent as completed

Update: Based on converations with @ryan.fisher we can do the following to generate GCN circulars for these:

For the start of O4:

• Create a button on the emfollow dashboard that will generate a template and upload to respective external event (and potentially superevent if detection)

Potentially later into O4

• Combine distance and FAP files to a singular file for simplicity
• Move FAP check out of ligo-followup-advocate and into gwcelery or PyGRB (by including a keyword argument)
• Automate creation of template via the upload of the new singular file

This first part is fixed by !1216 (merged)

assigned to @brandon.piotrzkowski and unassigned @naresh.adhikari

mentioned in merge request !1216 (merged)

closed with commit eff318eb

closed with merge request !1216 (merged)

reopened

changed epic to &11

changed epic to &8

changed milestone to %O4b