Skip to content

Commit

Permalink
Add NASA GCN v4.2.0
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Cruz Viotti <[email protected]>
  • Loading branch information
jviotti committed Jan 3, 2025
1 parent 50cd87c commit cacea92
Show file tree
Hide file tree
Showing 32 changed files with 1,074 additions and 0 deletions.
1 change: 1 addition & 0 deletions DEPENDENCIES
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
vendorpull https://github.com/sourcemeta/vendorpull dea311b5bfb53b6926a4140267959ae334d3ecf4
nasa-gcn-4-1-0 https://github.com/nasa-gcn/gcn-schema v4.1.0
nasa-gcn-4-2-0 https://github.com/nasa-gcn/gcn-schema v4.2.0
osv-schema-1-5-0 https://github.com/ossf/osv-schema v1.5.0
osv-schema-1-6-0 https://github.com/ossf/osv-schema v1.6.0
osv-schema-1-6-1 https://github.com/ossf/osv-schema v1.6.1
Expand Down
4 changes: 4 additions & 0 deletions configuration.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
}
},
"schemas": {
"nasa/gcn/v4.2.0": {
"base": "https://gcn.nasa.gov/schema/v4.2.0/gcn",
"path": "./vendor/nasa-gcn-4-2-0"
},
"nasa/gcn/v4.1.0": {
"base": "https://gcn.nasa.gov/schema/v4.1.0/gcn",
"path": "./vendor/nasa-gcn-4-1-0"
Expand Down
30 changes: 30 additions & 0 deletions vendor/nasa-gcn-4-2-0.mask
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.husky/
.npmrc
index.js
package-lock.json
package.json
README.md
update-tags.mjs
validate.mjs
gcn/notices/glowbug/Alert.example.json
gcn/notices/core/Reporter.example.json
gcn/notices/core/Statistics.example.json
gcn/notices/core/Localization.example.json
gcn/notices/core/Pointing.example.json
gcn/notices/burstcube/test.example.json
gcn/notices/burstcube/alert.example.json
gcn/notices/heasarc/archive_alert.example.json
gcn/notices/swift/bat/guano.loc_map.example.json
gcn/notices/swift/bat/Guano.example.json
gcn/notices/swift/bat/Guano.Retraction.example.json
gcn/notices/swift/bat/guano.loc_arc_min.example.json
gcn/notices/icecube/test/gold_bronze_track_alerts.example.json
gcn/notices/icecube/test/gold_bronze.update.example.json
gcn/notices/icecube/lvk_nu_track_search.example.json
gcn/notices/einstein_probe/wxt/alert.example.json
gcn/notices/svom/eclairs/trigger.catalog.example.json
gcn/notices/svom/eclairs/trigger.slewing.example.json
gcn/notices/svom/eclairs/trigger.not-slewing.example.json
gcn/notices/svom/eclairs/trigger.wakeup.example.json
gcn/notices/svom/grm/trigger.example.json
gcn/circulars.example.json
46 changes: 46 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/circulars.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/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": {
"type": "string",
"description": "Event name, automatically inferred from the subject"
},
"submitter": {
"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]>`"
},
"submittedHow": {
"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)"
}
},
"required": [
"eventId",
"submitter",
"subject",
"circularId",
"body",
"createdOn"
]
}
27 changes: 27 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/burstcube/alert.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/burstcube/alert.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alert",
"description": "BurstCube Trigger Alert",
"type": "object",
"allOf": [
{ "$ref": "../core/Alert.schema.json" },
{ "$ref": "../core/Reporter.schema.json" },
{ "$ref": "../core/DateTime.schema.json" },
{ "$ref": "../core/Event.schema.json" },
{ "$ref": "../core/Localization.schema.json" },
{ "$ref": "../core/Statistics.schema.json" },
{ "$ref": "../core/Duration.schema.json" }
],
"properties": {
"detector_status": {
"type": "object",
"properties": {
"CsI0": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI1": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI2": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI3": { "$ref": "../core/DetectorStatus.schema.json" }
}
}
}
}
27 changes: 27 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/burstcube/test.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/burstcube/test.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alert",
"description": "BurstCube Trigger Alert",
"type": "object",
"allOf": [
{ "$ref": "../core/Alert.schema.json" },
{ "$ref": "../core/Reporter.schema.json" },
{ "$ref": "../core/DateTime.schema.json" },
{ "$ref": "../core/Event.schema.json" },
{ "$ref": "../core/Localization.schema.json" },
{ "$ref": "../core/Statistics.schema.json" },
{ "$ref": "../core/Duration.schema.json" }
],
"properties": {
"detector_status": {
"type": "object",
"properties": {
"CsI0": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI1": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI2": { "$ref": "../core/DetectorStatus.schema.json" },
"CsI3": { "$ref": "../core/DetectorStatus.schema.json" }
}
}
}
}
13 changes: 13 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/AdditionalInfo.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/AdditionalInfo.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Comments",
"description": "Comments that are not summarized elsewhere in schema",
"properties": {
"additional_info": {
"type": "string",
"description": "Additional information about the event"
}
}
}
28 changes: 28 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/Alert.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/Alert.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alert",
"description": "Alert Information description properties of this notice",
"type": "object",
"properties": {
"alert_datetime": {
"type": "string",
"description": "Date and time of notice creation [UTC, ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
},
"alert_tense": {
"enum": [
"current",
"archival",
"planned",
"injection",
"commanded",
"test"
],
"description": "Indication of whether this alert refers to a recent observation (current), re-analysis of archival data (archival), a planned observation in the future (planned), a signal injection (injection), commanded trigger (commanded) or a test trigger (test)."
},
"alert_type": {
"enum": ["initial", "update", "retraction"],
"description": "Indication of alert sequence if multiple of same type sent"
}
}
}
25 changes: 25 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/DateTime.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/DateTime.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DateTime",
"description": "Time descriptions of transient event and observation",
"type": "object",
"properties": {
"trigger_time": {
"type": "string",
"description": "Time of the trigger [ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
},
"observation_start": {
"type": "string",
"description": "Start time of the observation [ISO 8601]"
},
"observation_stop": {
"type": "string",
"description": "Stop time of the observation [ISO 8601]"
},
"observation_livetime": {
"type": "number",
"description": "Livetime of the observation [s]"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/DetectorStatus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DetectorStatus",
"enum": ["on", "off", "triggered"],
"description": "Status of a specified detector at the time of the alert"
}
19 changes: 19 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/Distance.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/Distance.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Distance",
"description": "Luminosity Distance",
"properties": {
"luminosity_distance": {
"type": "number",
"description": "Luminosity distance [Mpc]"
},
"luminosity_distance_error": {
"type": "array",
"items": { "type": "number" },
"maxItems": 2,
"description": "Luminosity distance uncertainty [Mpc, 1-sigma], with optional asymmetric uncertainty"
}
}
}
28 changes: 28 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/Duration.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/Duration.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Duration",
"properties": {
"t90": {
"type": "number",
"description": "Time duration of central 90% of integrated fluence [s]"
},
"t90_error": {
"type": "array",
"items": { "type": "number" },
"maxItems": 2,
"description": "1-sigma uncertainty of the T90 duration [s], with asymmetric statistical errors taken into account"
},
"t50": {
"type": "number",
"description": "Time duration of central 50% of integrated fluence [s]"
},
"t50_error": {
"type": "array",
"items": { "type": "number" },
"maxItems": 2,
"description": "1-sigma uncertainty of the T50 duration [s], with asymmetric statistical errors taken into account"
}
}
}
23 changes: 23 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/Event.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/Event.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Event Information",
"description": "Name or names of the event",
"properties": {
"event_name": {
"type": "array",
"items": { "type": "string" },
"description": "Name of the event (ex: GRB 170817A, GW170817, AT2017gfo, SSS 17a)"
},
"id": {
"type": "array",
"items": { "oneOf": [{ "type": "string" }, { "type": "number" }] },
"description": "Instrument-specific trigger ID (ex: bn230313485 (Fermi), 1159327 (Swift)) or alternate ID"
},
"data_archive_page": {
"type": "string",
"description": "URL of archived data files"
}
}
}
26 changes: 26 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/FollowUp.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/FollowUp.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "FollowUp",
"description": "Schema specific to follow-up cases",
"type": "object",
"properties": {
"ref_type": {
"type": "string",
"description": "Type of the event detected, ex. GRB, GW, neutrino"
},
"ref_instrument": {
"type": "string",
"description": "Name of the reference mission or, instrument, ex. Fermi-GBM"
},
"ref_ID": {
"type": "string",
"description": "Trigger ID as reported by the reference instrument, ex. bnYYMMDDFF"
},
"reference": {
"type": "object",
"additionalProperties": { "type": ["number", "string"] },
"description": "Reference as distributed by the notices or circulars or ATel, ex. gcn circulars: 12345, gcn.notices.LVK.alert: SYYMMDDak-2-preliminary. "
}
}
}
26 changes: 26 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/GeoLocBase.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/GeoLocBase.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Spacecraft Geolocation and McIlwain L",
"description": "Enables GCN providers to include spacecraft geolocation and McIlwain L-Parameter.",
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Geocentric latitude [deg]"
},
"longitude": {
"type": "number",
"description": "Geocentric longitude [deg]"
},
"altitude": {
"type": "number",
"description": "Distance from the surface of the Earth [km]."
},
"mcilwain_l": { "type": "number", "description": "McIlwain L-parameter" },
"geoloc_time": {
"type": "string",
"description": "Time [UTC, ISO 8601] of the geolocation and McIlwain L-parameter, if different than the trigger time."
}
}
}
33 changes: 33 additions & 0 deletions vendor/nasa-gcn-4-2-0/gcn/notices/core/HardnessRatio.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"$id": "https://gcn.nasa.gov/schema/v4.2.0/gcn/notices/core/HardnessRatio.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "HardnessRatio",
"description": "Hardness Ratio parameterization",
"properties": {
"hardness_ratio": {
"type": "number",
"description": "ratio of flux between high and low energy bands"
},
"hardness_ratio_error": {
"type": "array",
"items": { "type": "number" },
"maxItems": 2,
"description": "ratio of flux between high and low energy bands, with asymmetric statistical errors taken into account"
},
"energy_range_soft": {
"type": "array",
"items": { "type": "number" },
"description": "Energy range [keV] used in soft band of hardness ratio",
"minItems": 2,
"maxItems": 2
},
"energy_range_hard": {
"type": "array",
"items": { "type": "number" },
"description": "Energy range [keV] used in hard band of hardness ratio",
"minItems": 2,
"maxItems": 2
}
}
}
Loading

0 comments on commit cacea92

Please sign in to comment.