Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add schema for the 1st SVOM notices (ECLAIRs, GRM & MXT) #245

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

timroland
Copy link
Contributor

@timroland timroland commented Feb 19, 2025

This PR introduce the SVOM notices in the common JSON format used by the NASA/GCN system.

It replaces the json schemas previously defined for SVOM notices as it was too complicated. Instead we simplify it by defining 3 schemas based on the SVOM instruments. Different notice examples are also included to illustrates the different notice subtypes.

{
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/svom/eclairs/eclairs.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For one schema and multiple notices, add "notice_type"

"notice_type": {
"type": "string",
"enum": [
"trigger",
"catalog",
"wakeup"
],
"description": "..."
},

A bit more organized, according you need.

Copy link
Member

@Vidushi-GitHub Vidushi-GitHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks neat.
As discussed, please feel free to use "notice_type" with "enum", when you are producing multiple notices with the use of one schema.

"$schema": true,
"slew_status": {
"enum": ["accepted", "rejected", "not_requested"],
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value can remain to 'not_requested'"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value can remain to 'not_requested'"
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value is 'not_requested'."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a simple prescription for the significance or a document you can reference where it's described?

Comment on lines +18 to +26
"properties": {
"$schema": true,
"triggered_GRDs": {
"type": "array",
"items": { "type": "boolean" },
"minItems": 3,
"maxItems": 3,
"description": "In case of a GRM trigger, trigger status the 3 GRDs. Each item correspond to one of the 3 GRDs: true means the GRD triggers, false not."
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using the DetectorStatus core schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants