Skip to content

Commit

Permalink
updates on screenshots and circulars (#14)
Browse files Browse the repository at this point in the history
* updates on screenshots and circulars

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* addressing comments

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* moved around new feature slides

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* Update index.html

Co-authored-by: Leo Singer <[email protected]>

* added back relative URI for schema

* Update index.html

---------

Co-authored-by: Leo Singer <[email protected]>
  • Loading branch information
jracusin and lpsinger authored Mar 6, 2023
1 parent faf4c5e commit 6b35a36
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 39 deletions.
Binary file added img/screen-shot-new-producers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
116 changes: 77 additions & 39 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ <h2>Why switch to the new GCN?</h2>
/>
<div data-markdown>
<textarea data-template>
## ✨New!✨ Self-service email alerts
## Self-service email alerts
Email is still the most popular way to receive GCN Notices.
* Previously, users had to contact Scott Barthelmy to create or modify their subscriptions manually.
* Now, you can manage your email subscriptions yourself through our new web site.
Expand All @@ -507,12 +507,12 @@ <h2>Why switch to the new GCN?</h2>
<textarea data-template>
## What’s staying the same?
GCN Classic is not going away any time soon. The following are still fully supported:
* GCN Notices legacy delivery mechanisms (email, socket, VOEvent Transport Protocol)
* GCN Notices legacy delivery mechanisms (email, socket, VOEvent Transport Protocol) of all current notice types
* GCN Circulars submission and delivery via email
* The old GCN Classic web site, https://gcn.gsfc.nasa.gov
* The live archives of [GCN Notices](https://gcn.gsfc.nasa.gov/burst_info.html) and [GCN Circulars](https://gcn.gsfc.nasa.gov/gcn3_archive.html) on the old web site
* The live archives of [GCN Notices](https://gcn.gsfc.nasa.gov/burst_info.html) on the old web site

However, starting later this year new features and notice types will only be available on the new web site and GCN Kafka.
However, new features and notice types are only available on the new web site and GCN Kafka.
</textarea>
</section>

Expand Down Expand Up @@ -627,6 +627,8 @@ <h1>Streaming GCN<br>Notices in Python</h1>
<textarea data-template>
## Step 4:<br>Get Sample Code
Copy and paste Python client code or download it to your computer to run.

Client sample code is also available in Node.js (ESM or CommonJS), C/C++, C#.
</textarea>
</div>
</div>
Expand Down Expand Up @@ -687,35 +689,30 @@ <h1>Streaming GCN<br>Notices in Python</h1>
---

## We’re planning lots of enhancements in the near future:
* Modernization of GCN Circulars
* New alert types and alerts from new missions and facilities
* Unified schema and alert format for GCN Kafka
* Modernization of GCN Circulars
* Integrated, searchable database of Notices and Circulars (GCN Viewer)
* Interoperability with other transient Kafka brokers (e.g. [SCiMMA](https://scimma.org))
* Alerts from new missions and facilities
</textarea>
</section>

<section>
<div class="image-and-caption">
<div>
<img src="img/screen-shot-gcn-markdown.png" width="700" alt="Screen shot of GCN Circular markdown">
</div>
<div data-markdown>
<textarea data-template>
## Modernization of GCN Circulars
* Manage your own subscriptions
* Self-register to submit using peer endorsement
* Submit circulars by web form, API, or email
* Correct handling of Unicode
* "Astro Flavored Markdown"
* Annotate and cross-link references, dates, times, coordinates
* Embedded data tables, image attachments, math mode
* Automatically mint DOIs and BiBTeX entries
* Link your ORCID to your GCN Circulars
</textarea>
</div>
</div>
</section>
<section>
<div class="image-and-caption">
<div>
<img src="img/screen-shot-new-producers.png" width="800" alt="Screen shot of New Notice Producers Documentation">
</div>
<div data-markdown>
<textarea data-template>
## Create new Notice types
* All new notice topics will only be distributed by GCN Kafka
* See [step-by-step instructions](https://gcn.nasa.gov/docs/producers)
* Preferred notice format is JSON
* [Unified JSON schema](https://github.com/nasa-gcn/gcn-schema) in development
</textarea>
</div>
</div>
</section>

<section data-markdown>
<textarea data-template>
Expand All @@ -727,27 +724,68 @@ <h1>Streaming GCN<br>Notices in Python</h1>
JSON example (in development):
```
{
"$id": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/fermi/gbm/Trigger.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Trigger",
"description": "fermi gbm Trigger",
"type": "object",
"title": "gcn.notices.icecube",
"description": "GoldAndBronze",
"properties": {
"type": {"description": "Notice type Gold or Bronze", "type": ["string"]},
"ra": {"description": "Localization estimate right ascension (degrees, ICRS, J2000)", "type": "number"},
"dec": {"description": "Localization estimate declination (degrees, ICRS, J2000)", "type": "number"},
"err50": {"description": "Location estimate uncertainty (radius, degrees)","type": "number"},
"dateobs": {"description": "Date and time of event", "type": "string", "format": "date-time"},
"revision": {"description": "Revision number by IceCube","type": [ "number"]},
"energy": {"description": "Most probable neutrino energy [TeV] that would have produced an event", "type": "number"},
"signalness": {"description": "Probability [dn] that this is an astrophysical signal relative to backgrounds", "type": "number"},
"far": {"description": "Rate of background events expected that are 'like this alert', would be seen by IceCube per year", "type": "number"},
"alert_info": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/AlertInfo.schema.json"
},
"identifiers": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Identifiers.schema.json"
},
"required": ["type", "ra", "dec", "err", "err50", "dateobs" "revision", "energy", "signalness", "far"]
"event_info": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/EventInfo.schema.json"
},
"datetime": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/DateTime.schema.json"
},
"localization": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Localization.schema.json"
},
"statistics": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Statistics.schema.json"
},
"hardness_ratio": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/HardnessRatio.schema.json"
},
"comments": {
"$ref": "https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/core/Comments.schema.json"
},
"specific": {
"$ref": "Specific.schema.json"
}
}
}
```

</textarea>
</section>

<section>
<div class="image-and-caption">
<div>
<img src="img/screen-shot-gcn-markdown.png" width="700" alt="Screen shot of GCN Circular web form">
</div>
<div data-markdown>
<textarea data-template>
## Modernization of GCN Circulars (Coming Soon!)
* Manage your own subscriptions
* Self-register to submit using peer endorsement
* Submit circulars by web form, API, or email
* New searchable archive of Circulars
* Planned enhancements
* "Astro-Flavored Markdown"
* Automatically mint DOIs and BiBTeX entries
* Link your ORCID to your GCN Circulars
</textarea>
</div>
</div>
</section>


<section class="conclusion-links">
<h1>Thanks for listening!</h1>
<p>Web site: <a href="https://gcn.nasa.gov/">https://gcn.nasa.gov</a></p>
Expand Down

0 comments on commit 6b35a36

Please sign in to comment.