add first notices for svom/eclairs

nasa-gcn / gcn-schema

Unified multi-mission schema for GCN Notices

https://gcn.nasa.gov/docs/schema/stable/gcn/notices

13 stars 22 forks source link

add first notices for svom/eclairs #126

Closed timroland closed 5 months ago

timroland commented 9 months ago

Here are the first 2 notices example of the SVOM/ECLAIRs alerts, with the associated "alert" schema.

lpsinger commented 9 months ago

@timroland, something weird happened with this PR; you seem to have altered almost every file in the repository.

dakota002 commented 9 months ago

He ran the steps for releasing a new version. We should probably clarify in the readme that this is not required for making PRs

lpsinger commented 9 months ago

@dakota002, would you please help @timroland fix this?

timroland commented 9 months ago

Ok that's done I deleted the commits that were problematic. Tell me if it is ok

timroland commented 8 months ago

I had a question about the topics that will be created with the new schema I defined. Will it be the same than the naming of the example files (i.e. begins with "gcn.notices.svom.alert." where is the notice type) ?

lpsinger commented 8 months ago

I had a question about the topics that will be created with the new schema I defined. Will it be the same than the naming of the example files (i.e. begins with "gcn.notices.svom.alert." where is the notice type) ?

No, it doesn't have to be exactly the same. You could create the Kafka topic gcn.notices.svom, or you could create multiple topics, one for each instrument: gcn.notices.svom.eclairs, gcn.notices.svom.grm. I would suggest not calling it .alert since that by itself doesn't add any information; all Kafka topics are for alerts of some kind.

lpsinger commented 8 months ago

@jracusin, @Vidushi-GitHub, would one of you please review this?

Vidushi-GitHub commented 7 months ago

@timroland As a gentle reminder, please make the following changes:

Description of "notice_level":
Update the "trigger_type": using core statistics schema

Thanks

timroland commented 6 months ago

Hi, sorry for the late reply... I updated the schema. I remove the notice_level parameter as it is in fact just an alias of the schema in the SVOM nomenclature (N1 are "trigger" notices and the letter stands for the instrument, it will appear in the documentation). I had a question concerning the "Pointing" schema as it has "ra" and "dec" parameters. How to distinguish from "ra" and "dec" paramaters from the Localization schema ?

Vidushi-GitHub commented 6 months ago

Hi, sorry for the late reply... I updated the schema. I remove the notice_level parameter as it is in fact just an alias of the schema in the SVOM nomenclature (N1 are "trigger" notices and the letter stands for the instrument, it will appear in the documentation). I had a question concerning the "Pointing" schema as it has "ra" and "dec" parameters. How to distinguish from "ra" and "dec" paramaters from the Localization schema ?

Hi, no worries. Thanks for the corrections.

Nice catch. While it may not be an issue for the archive in future, but consumers can easily get confused with localization (ra, dec), will come up with a better solution.

Vidushi-GitHub commented 5 months ago

Hi Tim (@timroland), thanks for the suggestion, we have recently updated the pointing schema to avoid the confusion of the same (ra, dec) pairs in localization as well. Please update the schema accordingly for renamed properties: (ra_pointing, dec_pointing), in the updated pointing schema.

Vidushi-GitHub commented 5 months ago

It seems this branch is complete and quite old. I double-checked it, and it validates. SVOM has pointing core schema, but it is not in use in schema example, thus no conflict with renamed (ra, dec).
As per conversation with @jracusin, I am merging this PR.