Skip to content

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

Open
timroland wants to merge 4 commits into
nasa-gcn:mainfrom
timroland:main
Open

Add schema for the 1st SVOM notices (ECLAIRs, GRM & MXT)#245
timroland wants to merge 4 commits into
nasa-gcn:mainfrom
timroland:main

Conversation

@timroland
Copy link
Copy Markdown
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.

Comment thread gcn/notices/svom/eclairs/eclairs.schema.json
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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 thread gcn/notices/svom/grm/grm.schema.json
Comment thread gcn/notices/svom/mxt/mxt.schema.json Outdated
Copy link
Copy Markdown
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.

Please replace localisation word to localization for consistency.
If you feel users may need different topics for eclairs catalog and slewing, please feel free to make different schemas.

To me rest of the stuff looks good to proceed.

"alert_tense": "current",
"alert_type": "initial",
"alert_datetime": "2024-02-22T08:51:55",
"id": ["sb24022203"],
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please use as a single string, not array for single array, core schema is upgraded.

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