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 GCN Circulars schema #154

Merged
merged 8 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions gcn/circulars.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://gcn.nasa.gov/schema/main/gcn/circulars.schema.json",
"eventId": "GRB 230410A",
"submitter": "Fermi GBM Team at MSFC/Fermi-GBM <[email protected]>",
"submittedHow": "email-legacy",
"subject": "GRB 230410A: Fermi GBM Final Real-time Localization",
"circularId": 33603,
"format": "text/plain",
"body": "The Fermi GBM team reports the detection of a likely LONG GRB\\n\\nAt 11:26:00 UT on 10 Apr 2023, the Fermi Gamma-ray Burst Monitor (GBM) triggered and located GRB 230410A (trigger 702818765.135562 / 230410476).\\n\\nThe on-ground calculated location, using the Fermi GBM trigger data, is RA = 352.3, Dec = 22.9 (J2000 degrees, equivalent to J2000 23h 29m, 22d 53'), with a statistical uncertainty of 2.1 degrees.\\n\\nThe angle from the Fermi LAT boresight is 72.0 degrees.\\n\\nThe skymap can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_skymap_all_bn230410476.png\\n\\nThe HEALPix FITS file, including the estimated localization systematic, can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_healpix_all_bn230410476.fit\\n\\nThe GBM light curve can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_lc_medres34_bn230410476.gif",
"createdOn": 1718212589034
}
38 changes: 38 additions & 0 deletions gcn/circulars.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"$id": "https://gcn.nasa.gov/schema/main/gcn/circulars.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "GCN Circular",
"description": "GCN Circulars are rapid astronomical bulletins submitted by and distributed to community members worldwide. They are used to share discoveries, observations, quantitative near-term predictions, requests for follow-up observations, or future observing plans related to high-energy, multi-messenger, and variable or transient astrophysical events. An archive of all GCN Circulars can be found at https://gcn.nasa.gov/circulars",
"properties": {
"eventId": {
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub Jun 12, 2024

Choose a reason for hiding this comment

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

How about using event_name from Event Core Schema (https://github.com/nasa-gcn/gcn-schema/blob/v4.0.0/gcn/notices/core/Event.schema.json)?
It can be same property for both Circulars and Notices, helpful for correlation.

Copy link
Member Author

Choose a reason for hiding this comment

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

We could, but we would need to migrate the whole GCN Circulars database if we changed field names.

Copy link
Member

Choose a reason for hiding this comment

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

Ohh, may be one more translation layer can help later.
@jracusin what is your opinion keeping the name as available in Unified Schema or it's fine?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think we need a translation layer. I agree with you, @Vidushi-GitHub, that this schema is not very consistent with GCN Notices. We should discuss if and how we should achieve this transition.

"type": "string",
"description": "Event name, automatically inferred from the subject"
},
"submitter": {
Vidushi-GitHub marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"description": "Name, affiliation, and email address of the person who submitted the Circular, in the form `A. E. Einstein at IAS <[email protected]>`"

This comment was marked as resolved.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not any kind of standard.

},
"submittedHow": {
Copy link
Member

Choose a reason for hiding this comment

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

How about "submissionMethod"? sounds more appropriate

"enum": ["web", "email", "email-legacy", "api"],
"description": "Specifies the method by which the user submitted the Circular"
},
"subject": {
"type": "string",
"description": "Subject line of the Circular"
},
"circularId": {
"type": "number",
"description": "Circular ID assigned to the Circular in the GCN Circulars archive. This value is unique to each published Circular and increments by 1"
},
"format": {
"enum": ["text/plain", "text/markdown"],
"description": "Format of the body text as a MIME type. See https://gcn.nasa.gov/docs/circulars/markdown for documentation on using Markdown in Circulars"
},
"body": { "type": "string", "description": "Body text" },
"createdOn": {
"type": "number",
"description": "Date and time the Circular is accepted and published onto the GCN Circulars archive, formatted as a UNIX timestamp (milliseconds since the UNIX epoch)"
}
}
}
Loading