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 2nd set of SVOM notices for ECLAIRs, GRM and MXT #182

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

timroland
Copy link
Contributor

@timroland timroland commented Jul 25, 2024

I added the 2nd set of notices for ECLAIRs, GRM and ECLGRM (joint analysis). These are defined in the refined.schema.json
I also added the schema and an example for the 1st set of MXT notices in the dedicated folder.

PS: All these notices are refered to level 2 notices in the SVOM nomenclature

"$schema": true,
"mean_flux": {
"type": "number",
"description": "Mean flux of the detection [erg.cm^-2]"
Copy link
Member

Choose a reason for hiding this comment

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

Flux units are (erg cm^-2 s^-1), we have energy_flux property defined in our core schema (https://raw.githubusercontent.com/nasa-gcn/gcn-schema/main/gcn/notices/core/spectral/GammaRay.schema.json), might be useful here.
erg cm^-2 is units for fluence.

},
"use_VT_attitude": {
"type": "boolean",
"description": "Whether the platform stabilisation process uses the VT instead of the standard star tracker. This leads to an improved localization."
Copy link
Member

Choose a reason for hiding this comment

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

Please clearly write about 0, 1 state in the description.

"$schema": true,
"slew_status": {
"enum": ["accepted", "rejected", "not-requested"],
"description": "Spacecraft slew status"
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Aug 1, 2024

Choose a reason for hiding this comment

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

Describe it clearly for the users.

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 good.

Main comment: Is it possible to have a separate topic for each instrument (excluding test) - one for eclairs, one for grm, and one for eclgrm (joint-analysis)?

This way, the alert/trigger can be on one Kafka topic for user subscription.
Exception is a test topic that can be an independent topic subscribed by the team.

We have a record number field in the reporter schema (https://raw.githubusercontent.com/nasa-gcn/gcn-schema/main/gcn/notices/core/Reporter.schema.json) for refined Notices."

"hardness_ratio_error": [0.01],
"energy_range_soft": [4.0, 20.0],
"energy_range_hard": [80.0, 120.0],
"classification": { "short_grb": 26.0, "long_grb": 74.0 },
Copy link
Member

Choose a reason for hiding this comment

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

Interesting!
Suggestion: Either document on the mission page or AdditionalInfo Schema to let the community know which classification scheme you are using.

@timroland
Copy link
Contributor Author

Thanks for your review, I will make the changes.

Concerning the topics, actually there will be a separate topic for each instrument. We will always call it by: the instrument, followed by the name of the schema (trigger or refined) and potentially another keyword for more specific notices (slewing/not-slewing, catalog, etc.). Do you find it ok ?

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.

Hi @timroland, this branch looks quite done.
Could you please update the description of "slew_status" and classification scheme you are following?

P.S. Sorry I missed your email during Astro-COLIBIRI, wasn't carrying official laptop.

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.

One of the main concern is would you like to reduce number of example files?
For example, trigger.catalog, trigger.not-slewing, trigger.slewing are consists of almost same properties, that can be streamed as one topic.

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.

2 participants