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 5 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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I will write a paragraph to detail the classification scheme in the mission page. The method is not completely finalised yet but at least the categories are here

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

@timroland
Copy link
Contributor Author

I just made some simplification of the schema and examples.
Actually, the previous slewing and not-slewing topics transmit the same notices (with a different slew status). So they are merged in the same slew topic

@Vidushi-GitHub
Copy link
Member

Vidushi-GitHub commented Nov 13, 2024

Thank you @timroland.

This rebase is touching other files, either address the conflicts or create a new PR for further feedbacks.

@timroland
Copy link
Contributor Author

Yes, sorry, I messed up a bit my rebase. I think I fixed it

@Vidushi-GitHub
Copy link
Member

Yes, sorry, I messed up a bit my rebase. I think I fixed it

Thank you. Is this ok to review again or you are in the process of adding content?

@timroland
Copy link
Contributor Author

timroland commented Nov 20, 2024

No it is ok to review it, thanks ! (in parallel with the mission page)

@Vidushi-GitHub
Copy link
Member

Vidushi-GitHub commented Nov 20, 2024

I'm a bit confused about the number of schemas and examples provided. There are three schemas: svom.trigger, svom.refined, and svom.mxt.localization. These schemas should correspond to the number of Kafka topics requested to us.

I cannot find the detector property in the schema, especially since you are using examples from each instrument (eclairs, eclgrm, and grm). It would be helpful to provide the instrument names as an enum if you plan to use svom.trigger and svom.refined as parent schemas.

In the core schema, we have alert_type, which can be utilized to consolidate the trigger and refined topics into one, using initial and updated fields, respectively.

@timroland
Copy link
Contributor Author

timroland commented Nov 22, 2024

Thanks for the review.
Actually I thought that the name of the schemas did not have to be the same as the topic names. But just need to appear in the topic name...
Actually the trigger and refined schemas are quite different because they contain different type of information. The first one contain information about the trigger and the second one contain information about the light curve analysis of the trigger (which comes a bit later in the sequence). Plus, both ECLAIRs and GRM can issued these 2 types of notices with exactly similar fields. That is why I made only 2 schemas instead of 4. But I can make dedicated schemas for each instrument if it is necessary for your system or just if it is cleaner.

@Vidushi-GitHub
Copy link
Member

Thanks for the review. Actually I thought that the name of the schemas did not have to be the same as the topic names. But just need to appear in the topic name... Actually the trigger and refined schemas are quite different because they contain different type of information. The first one contain information about the trigger and the second one contain information about the light curve analysis of the trigger (which comes a bit later in the sequence). Plus, both ECLAIRs and GRM can issued these 2 types of notices with exactly similar fields. That is why I made only 2 schemas instead of 4. But I can make dedicated schemas for each instrument if it is necessary for your system or just if it is cleaner.

I think it's good to have one topic for each instrument, with one schema for each. It will be easier for community to subscribe each topic corresponding to instrument of theirs interest.
If you wish we can plan a meeting, for suggestions.

@timroland
Copy link
Contributor Author

Right, I see. Actually, we would like to be a bit more precise than one topic by instruments as they work together and release data on different timescale according to each other.
In the mission page I edited, I explained a bit more the information each notice contains. We could indeed plan a meeting to discuss all this, this will be easier. would Friday be good for you ?

@Vidushi-GitHub
Copy link
Member

Vidushi-GitHub commented Nov 28, 2024

Right, I see. Actually, we would like to be a bit more precise than one topic by instruments as they work together and release data on different timescale according to each other. In the mission page I edited, I explained a bit more the information each notice contains. We could indeed plan a meeting to discuss all this, this will be easier. would Friday be good for you ?

@timroland How about Friday 10:30 edt/4:30 cet? If ok with you will email you meeting link.

@timroland
Copy link
Contributor Author

Ok thanks, perfect I will send you an email with a zoom link.

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