Skip to content

Commit

Permalink
eventID documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jracusin committed Jan 23, 2025
1 parent e2be6c9 commit 218fdfd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
2 changes: 2 additions & 0 deletions app/routes/circulars._archive._index/route.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,8 @@ export default function () {
<Hint id="searchHint">
Search for Circulars by submitter, subject, or body text (e.g. 'Fermi
GRB'). <br />
Search for Circulars by eventID (e.g. 'GRB 123456A', 'GRB123456A',
'123456A'). <br />
To navigate to a specific circular, enter the associated Circular ID
(e.g. 'gcn123', 'Circular 123', or '123').
</Hint>
Expand Down
21 changes: 21 additions & 0 deletions app/routes/docs.circulars.archive.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,27 @@ You can search the Circulars Archive by keywords or phrases in the subject, body

You can also filter search results by submission date. Select the dropdown button labeled "Filter by date". From there, you can either select from a number of predefined time ranges (e.g., "Last Hour", "Last Day", etc.) or specify a custom date range, which can either be set as a start date, an end date, or both. All search filters can be cleared by clicking the 'x' button in the search bar.

## Group View

The Circulars archive provides a Group View that allows users to view all Circulars associated with a particular astronomical event. This is enabled by the eventID and Synonym Groups features.

Each Circular is automatically assigned an `eventID` derived from the `Subject` field (e.g. GRB 250109A, EP250109a). This assignment is done by matching against the following regular expressions list:
REGEX from circulars.lib.ts

The `eventID` is listed in the JSON format version of Circulars. The first eventID used in the subject is associated automatically, and all Circulars with the same eventID are in a Synonym Group. GCN moderators can associate multiple eventIDs to Synonym Groups, such that all Circulars with these eventIDs will be listed in the same viewed group.

### Adding events to the same synonym group

GCN Team moderators can create or modify synonym groups. If you would like to suggest the creation or modification of a synonym group, submit a ticket via [the contact form](/support).

### Searching by eventID

In either Group View or the Circulars Archive search bar, you type in an eventID and it will take you to the associated Synonym Group. It will recognize regular expressions associated with the `eventID` (e.g. GRB 123456A, GRB123456A, 123456A).

### Linking to an eventID or Synonym Group

To save a direct link to all Circulars assocaited with a particular `eventID` or Synonym Group, you can point to any `eventID` in that group, e.g. `https://gcn.nasa.gov/circulars/group/[eventID]'.

## Citing GCN Circulars

The [SAO/NASA Astrophysics Data System (ADS)](https://ui.adsabs.harvard.edu) ingests and indexes all GCN Circulars. You can use ADS to get bibliographic records for GCN Circulars to cite them in a publication.
Expand Down
2 changes: 1 addition & 1 deletion app/routes/docs.circulars.corrections/route.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import versionbuttonscreenshot from './version_button.png'

# Corrections

Circulars authors can request changes to archived Circulars to correct inaccurate information, especially when the correction is important for the follow-up community's activities. These may include author lists, subject corrections, typos, and incorrect citations. Do not use the corrections feature to add details of new observations or analyses. In such cases, submit a new Circular with an appropriate subject (e.g. "refined analysis" or "additional observations").
Circulars authors can request changes to archived Circulars to correct inaccurate information, especially when the correction is important for the follow-up community's activities. These may include author lists, subject corrections, eventID additions or corrections, typos, and incorrect citations. Do not use the corrections feature to add details of new observations or analyses. In such cases, submit a new Circular with an appropriate subject (e.g. "refined analysis" or "additional observations").

## Who can request corrections?

Expand Down

0 comments on commit 218fdfd

Please sign in to comment.