FRB Schema for the CHIME Telescope

[tabbott36]

Description

Added the FRB schema for the Canadian Hydrogen Intensity Mapping Experiment (CHIME). Also added an example json for each alert type (detection, subsequent, retraction, and update).

Questions for GCN Team

• I tentatively used the "alert_type" parameter (from the Alert schema), however, there are 4 alert types for CHIME/FRB, so if this is not the correct decision, I can add a property to the FRB schema.
• Can I use a Transient Name Server name for the "id" parameter in the Event schema?

Testing

I modelled the schema after other observatories' schemas but am open to suggestions regarding testing.

[tabbott36]

Seeing many failed checks, is there action I should take on this? Cheers!

[lpsinger]

Seeing many failed checks, is there action I should take on this? Cheers!

Yes, there were some missing contributing instructions to configure pre-commit hooks. See #218.

[Vidushi-GitHub]

@tabbott36 A gentle reminder. Please validate it and run prettier, before we start reviewing it.

[dakota002]

Hi @tabbott36, I see from your commits that you ran the version command. You don't need to do so, as we will take care of this once your updates are merged into main. Can you please revert the changes in your repo that update fields from 4.1.0 to 4.2.0?

Also, I would suggest updating the names of your example files, for example: from gcn/notices/chime/subsequent.example.json to gcn/notices/chime/frb.subsequent.example.json. The schema name (frb) as a prefix will allow our schema viewer to properly recognize which schema it is an example for

[tabbott36]

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

[dakota002]

This is not a valid option, the allowed values are:

"allowedValues": [
        "initial",
        "update",
        "retraction"
      ]

These are defined here https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Alert.schema.json

[tabbott36]

Thanks for the review, I was hoping to be consistent with existing CHIME/FRB Alert types (see issue 198), but if this is too much trouble, "initial" can replace what we currently call "detection" and "subsquent".

[Vidushi-GitHub]

@tabbott36 we are working on adding subsequent (see #221).
However, initial will likely remain the same, else we need to take votes from the missions that are already using it.

For validation, as detection and subsequent please add a new property, current alert_type is not consistent.

[tabbott36]

Ok, sounds good to me. Thanks, Vidushi!

[dakota002]

This is also not a valid value for alert_type, would update make sense here?

[dakota002]

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

No problem! I have suggested a few other changes that should also fix your validation checks