Healpix doc

[Vidushi-GitHub]

Description

Add document for parsing and using HEALPix docs

Explaining what it represents, how one can understand a skymap

• Mollweide skymap shape, compare to map of glob projected onto flat surface
• What are multi-order skymaps?
• Explain difference between them, why they exist (size)
• How to work with healpix maps
• Which packages you need, here you can link to the various package documentations
• What each of the packages do
• Read in a skymap
• How to identify credibility regions (existing IGWN docs are pretty much what we need)
• Identifying a point being inside that credibility region
• Finding probability of cone/polygon (essentially credibility region for x%) (another IGWN doc)
• At the end of the section, link to IGWN docs for further information (or at start of section? Can discuss)
• Usage of 2d/3d skymaps, link to more extensive docs on this topic
• Moc papers?

Resolves: #2035

[lpsinger]

Please fix the following build error:

css-bundle-entry-module:__remix_cssBundleEntryModule__:45:25: ERROR: [plugin: remix-mdx] Could not parse import/exports with acorn: SyntaxError: Unexpected token [plugin css-bundle-plugin]

The cause of this error is the imports in your Python sample code, which is enclosed in triple quotes ('''). Triple quotes don't do anything in Markdown, so the MDX parser is attempting to interpret those lines as JavaScript imports. The correct delimiter for a code block in Markdown is triple backticks (```).

[tylerbarna]

Is there a reason why we still have this marked as a draft?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 5.85%. Comparing base (a15bd53) to head (a88fa4f).

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #2498   +/-   ##
=====================================
  Coverage   5.85%   5.85%           
=====================================
  Files        171     171           
  Lines       4324    4324           
  Branches     474     474           
=====================================
  Hits         253     253           
  Misses      4069    4069           
  Partials       2       2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Vidushi-GitHub]

Is there a reason why we still have this marked as a draft?

Following #2035, two points are still incomplete:
(a) making a joint skymap by multiplying and normalizing two skymaps
(b) describe usage of 2d and 3d skymaps

[jracusin]

What happened to the documentation on including healpix maps in producing notices?

[Vidushi-GitHub]

What happened to the documentation on including healpix maps in producing notices?

If I understand it correctly it should be similar as
"healpix_fits_url": {
"type": "string",
"description": "URL or file path to the HEALPix FITS map"
}

Then consumer needs document to read it from the above doc.

[Vidushi-GitHub]

What happened to the documentation on including healpix maps in producing notices?

If I understand it correctly it should be similar as "healpix_fits_url": { "type": "string", "description": "URL or file path to the HEALPix FITS map" }

Then consumer needs document to read it from the above doc.

For attaching the fits file, it's mentioned in PR: https://github.com/nasa-gcn/gcn.nasa.gov/pull/2669/files

Is this sufficient?

[jracusin]

Add a list of categories of sample codes at the top linking to the appropriate headings.

[Vidushi-GitHub]

Recent Version screenshot! There are some breaks, which are not well captured with screenshots.
For cross-linking point of view, we haven's discussed any word about skymaps over Unified Schema page. Shall we, then only we can add link?

[lpsinger]

This is starting to look good. Just some typos and code errors.

[tylerbarna]

Couple of stylistic suggestions to maintain consistency, but none of them are necessary changes

[tylerbarna]

@Vidushi-GitHub looks like one of the suggested changes in my review from either 4aa3cf1 or f89aa0f caused the checks to fail

[Vidushi-GitHub]

@Vidushi-GitHub looks like one of the suggested changes in my review from either 4aa3cf1 or f89aa0f caused the checks to fail

It was due to prettier, sorted!

[Vidushi-GitHub]

@tylerbarna Did you test the coding part?