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

FRB Schema for the CHIME Telescope #217

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

Conversation

tabbott36
Copy link
Contributor

@tabbott36 tabbott36 commented Nov 5, 2024

Description

Added a schema for fast radio bursts (FRBs). I have also included an example json for FRB alerts from the Canadian Hydrogen Intensity Mapping Experiment (CHIME) for each alert type (detection, subsequent, retraction, and update).

Questions for GCN Team

  • Can I use a Transient Name Server name for the "id" parameter in the Event schema?

Testing

  • I modelled the schema after other observatories' schemas but am open to suggestions regarding testing.

@tabbott36
Copy link
Contributor Author

Seeing many failed checks, is there action I should take on this? Cheers!

@lpsinger
Copy link
Member

lpsinger commented Nov 5, 2024

Seeing many failed checks, is there action I should take on this? Cheers!

Yes, there were some missing contributing instructions to configure pre-commit hooks. See #218.

@Vidushi-GitHub
Copy link
Member

Vidushi-GitHub commented Nov 18, 2024

@tabbott36 A gentle reminder. Please validate it and run prettier, before we start reviewing it.

@dakota002
Copy link
Contributor

Hi @tabbott36, I see from your commits that you ran the version command. You don't need to do so, as we will take care of this once your updates are merged into main. Can you please revert the changes in your repo that update fields from 4.1.0 to 4.2.0?

Also, I would suggest updating the names of your example files, for example: from gcn/notices/chime/subsequent.example.json to gcn/notices/chime/frb.subsequent.example.json. The schema name (frb) as a prefix will allow our schema viewer to properly recognize which schema it is an example for

@tabbott36
Copy link
Contributor Author

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

@dakota002
Copy link
Contributor

Hi @dakota002, thanks for the help! Yes, I will revert the versioning and rename the example files.

No problem! I have suggested a few other changes that should also fix your validation checks

@dakota002
Copy link
Contributor

@tabbott36 This looks good to me now, can you please squash your commits down to 1? If you have questions on this I can assist you

… the frb schema

feat(chime/frb.schema.json): final touches on the FRB schema "properties"

fix(npm): Fixed npm checks

4.2.0

Back to development

Update gcn/notices/chime/frb.schema.json

Co-authored-by: Dakota Dutko <[email protected]>

Update gcn/notices/chime/detection.example.json

Co-authored-by: Dakota Dutko <[email protected]>

Update gcn/notices/chime/retraction.example.json

Co-authored-by: Dakota Dutko <[email protected]>

Update gcn/notices/chime/subsequent.example.json

Co-authored-by: Dakota Dutko <[email protected]>

Update gcn/notices/chime/update.example.json

Co-authored-by: Dakota Dutko <[email protected]>

fix(Versioning): reverted version number to 4.1.0

fix(version): Reverted the version to 4.1.0 using npm

fix(gal_el_model-properties): corrected galactic electron density model properties

fix(Data-types): Fixed incorrect data types in FRB schema
@tabbott36
Copy link
Contributor Author

Sure thing! I believe it's been squashed to one commit now. Thanks!

@dakota002 dakota002 self-requested a review December 10, 2024 16:14
@dakota002
Copy link
Contributor

@Vidushi-GitHub @jracusin is this good now?

@Vidushi-GitHub
Copy link
Member

@Vidushi-GitHub @jracusin is this good now?

We still are working on it.

},
"snr": {
"type": "number",
"description": "Signal-to-noise ratio of the burst"
Copy link
Member

Choose a reason for hiding this comment

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

Is this different from rate_snr in core/Statistics.schema.json?

Suggested change
"description": "Signal-to-noise ratio of the burst"
"description": "Signal-to-noise ratio of the burst [dimensionless]"

Copy link
Contributor Author

@tabbott36 tabbott36 Feb 11, 2025

Choose a reason for hiding this comment

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

Thanks for the suggestion - I will add [dimensionless] to the description.

Though "snr" and "rate_snr" are very similar, I think it would be misleading to call it "rate_snr" in the context of fast radio bursts. In the high energy regime, rates is usually a measure of photon counts / time, but for radio transients, rates are usually a measure of bursts / time. In other words, a "rate_snr" for a fast radio burst might mislead people into thinking there were multiple bursts detected.

"type": "number",
"description": "The time resolution of the real-time FRB search."
},
"bandwidth": {
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Dec 12, 2024

Choose a reason for hiding this comment

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

Do you think it's same as spectrum property in core/Reporter.schema.json?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, yes, it looks like the same thing. "bandwidth" here is the frequencies over which the instrument observes, so I think it alligns well with the "spectrum" property. I'll update it! Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking back at this, I am noticing that "spectrum" is one of ["energy", "wavelength", "frequency"], which I originially misunderstood. Since bandwidth is a number describing the observatory's observing band, I've reintroduced it into the FRB schema.

@Vidushi-GitHub
Copy link
Member

Hi @tabbott36, we have added a few properties in core schema motivated from your CHIME/FRB schema, thanks!
Please provide your valuable feedback for #226. Please comment on what are usually common properties among FRBs, that should be include in the core.

@jracusin
Copy link
Contributor

Is this FRB schema intended to be generic for other FRB experiments or specific to CHIME?

@tabbott36 tabbott36 reopened this Feb 11, 2025
…ons in PR nasa-gcn#217 and updated the frb example JSONs

Also made modifications to the definitions of spectrum and spectral_center in the Reporter.schema.json
@tabbott36
Copy link
Contributor Author

Is this FRB schema intended to be generic for other FRB experiments or specific to CHIME?

I've been aiming to make it generic since many other FRB detecting observatories will likely be interested in eventually joining the GCN.

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.

5 participants