Healpix doc #2498

Vidushi-GitHub · 2024-07-29T22:19:17Z

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 · 2024-07-30T02:58:44Z

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 (```).

app/routes/docs.notices.healpix.mdx

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

previous commits had hyperlink brackets/parentheses used incorrectly

recreate lost content

app/routes/docs.notices.healpix.mdx

Vidushi-GitHub · 2024-07-30T20:32:57Z

app/routes/docs.notices.healpix.mdx

+hp_index = np.argmax(skymap['PROBDENSITY'])
+uniq = skymap[hq_index]['UNIQ']
+
+level, ipix = ah.uniq_to_level_ipix(uniq)


We should introduce a UNIQ scheme a bit.

app/routes/docs.notices.healpix.mdx

this relocates the documentation into the sample code page under the kafka client setup

lpsinger · 2024-08-02T18:44:31Z

app/routes/docs.client.samples.md

+(1) Calabretta, M. R., & Roukema, B. F. 2007, Mon. Notices Royal Astron. Soc., 381, 865. [doi:10.1111/j.1365-2966.2007.12297.x](https://academic.oup.com/mnras/article/381/2/865/1021805?login=true)
+
+(2) Górski, K.M., Hivon, E., Banday, A.J., et al. 2005, Astrophys. J., 622, 759. [doi:10.1086/427976](https://iopscience.iop.org/article/10.1086/427976)
+
+(3) Górski, K. M., Wandelt, B. D., et al. 1999. [arXiv:astro-ph/9905275](https://arxiv.org/abs/astro-ph/9905275)
+
+(4) Fernique, P., Allen, et al. 2015, Astron. Astrophys., 578, A114. [doi:10.1051/0004-6361/201526075](https://www.aanda.org/articles/aa/full_html/2015/06/aa26075-15/aa26075-15.html)
+
+(5) Fernique, P., Boch, T., et al. 2014, IVOA Recommendation. [arXiv:1505.02937](https://arxiv.org/abs/1505.02937)
+
+(6) Martinez-Castellanos, I., Singer, L. P., et al. 2022, Astrophys. J., 163, 259. [doi:10.3847/1538-3881/ac6260](https://iopscience.iop.org/article/10.3847/1538-3881/ac6260)
+
+(7) Singer, L. P., & Price, L. R. 2016, Phys. Rev. D, 93, 024013. [doi:10.1103/PhysRevD.93.024013](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.93.024013)


Please use DOIs for all paper URLs.

resolved in 569e18c

remove extra breadcrumb that was not appropriate to include and change imports to be at the top of the page

all references use doi now, and they are also updated such that they use the standardized doi link as well

tylerbarna · 2024-10-07T17:31:49Z

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

codecov · 2024-10-07T17:32:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.23%. Comparing base (46ec6cc) to head (e86f307).
Report is 171 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##            main   #2498      +/-   ##
========================================
+ Coverage   5.27%   6.23%   +0.96%     
========================================
  Files        157     167      +10     
  Lines       3906    4248     +342     
  Branches     419     472      +53     
========================================
+ Hits         206     265      +59     
- Misses      3699    3981     +282     
- Partials       1       2       +1

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

Vidushi-GitHub · 2024-10-09T17:23:10Z

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 · 2024-11-16T11:08:39Z

app/routes/docs.client.samples.md

+## HEALPix Sky Maps
+
+HEALPix stands for <b>H</b>ierarchical, <b>E</b>qual <b>A</b>rea, and iso-<b>L</b>atitude <b>Pix</b>elisation is a scheme for indexing positions on the unit sphere.
+For localization of events, the multi-messenger community uses the standard [HEALPix](https://healpix.sourceforge.io) format with the file extension `.fits.gz`, as well as multi-resolution HEALPix format with the file extension `.multiorder.fits`. The preferred format is the multi-resolution HEALPix format, that is only format explicitly listed in the GCN.


'.gz' isn't specific to a healpix file, it's just showing that it's zipped.
Also, what is meant by "listed in the GCN"?

No, it's not specific to HEALPix, but the convention for localization FITS files is that it's either a flat-resolution file and gzip-compressed, or a multi-order file and not compressed. @Vidushi-GitHub's text here is correct within this context.

jracusin · 2024-11-16T11:09:31Z

app/routes/docs.client.samples.md

+
+### Working with HEALPix Maps
+
+HEALPix data is distrubuted in standard format with the file extension `.fits.gz`. These files are FITS image files and can be utilized with many common FITS tools. These files usually stored as HEALPix projection,


incomplete sentence

jracusin · 2024-11-16T11:10:36Z

app/routes/docs.client.samples.md

+
+[healpy](https://healpy.readthedocs.io/en/latest/): Official python library for handling the pixlated data on sphere
+
+[astropy-healpix](https://pypi.org/project/astropy-healpix/)


add description

jracusin · 2024-11-16T11:12:20Z

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

app/routes/docs.client.samples.md

Vidushi-GitHub · 2024-12-02T04:31:33Z

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.

Healpix doc

3e4e59d

Vidushi-GitHub requested a review from tylerbarna July 29, 2024 22:19

fix code markdown

4cfb926

lpsinger requested changes Jul 30, 2024

View reviewed changes

app/routes/docs.notices.healpix.mdx Outdated Show resolved Hide resolved

Vidushi-GitHub and others added 4 commits July 30, 2024 10:12

Update app/routes/docs.notices.healpix.mdx

c58d3fc

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

Markdown for python

e3c495e

correct hyperlinks

1cf3ef1

previous commits had hyperlink brackets/parentheses used incorrectly

rewrite known prob density

b5e9012

recreate lost content

Vidushi-GitHub commented Jul 30, 2024

View reviewed changes

app/routes/docs.notices.healpix.mdx Outdated Show resolved Hide resolved

Vidushi-GitHub commented Jul 30, 2024

View reviewed changes

update reference

54fc7bb

tylerbarna reviewed Aug 1, 2024

View reviewed changes

app/routes/docs.notices.healpix.mdx Outdated Show resolved Hide resolved

tylerbarna and others added 4 commits August 1, 2024 11:46

Update app/routes/docs.notices.healpix.mdx

be44d76

mollweide, prob in cone, and papers

bb74178

move documentation

7499763

this relocates the documentation into the sample code page under the kafka client setup

remove link to deleted healpix page

f624380

lpsinger requested changes Aug 2, 2024

View reviewed changes

tylerbarna added 2 commits August 2, 2024 15:22

corrections to breadcrumbs and imports

1fda4d8

remove extra breadcrumb that was not appropriate to include and change imports to be at the top of the page

resolve doi issue

569e18c

all references use doi now, and they are also updated such that they use the standardized doi link as well

dakota002 assigned tylerbarna and Vidushi-GitHub Oct 9, 2024

dakota002 marked this pull request as ready for review October 9, 2024 16:29

Vidushi-GitHub requested a review from tylerbarna October 9, 2024 17:23

Vidushi-GitHub mentioned this pull request Nov 6, 2024

Schema: Parsing HEALPix Maps #1205

Closed

jracusin reviewed Nov 16, 2024

View reviewed changes

Vidushi-GitHub commented Dec 2, 2024

View reviewed changes

app/routes/docs.client.samples.md Outdated Show resolved Hide resolved

Update app/routes/docs.client.samples.md

4ac8339

Vidushi-GitHub commented Dec 2, 2024

View reviewed changes

app/routes/docs.client.samples.md Outdated Show resolved Hide resolved

Update app/routes/docs.client.samples.md

e86f307

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Healpix doc #2498

Healpix doc #2498

Vidushi-GitHub commented Jul 29, 2024 •

edited

Loading

lpsinger commented Jul 30, 2024

Vidushi-GitHub Jul 30, 2024

lpsinger Aug 2, 2024

tylerbarna Oct 7, 2024

tylerbarna commented Oct 7, 2024

codecov bot commented Oct 7, 2024 •

edited

Loading

Vidushi-GitHub commented Oct 9, 2024

jracusin Nov 16, 2024

lpsinger Nov 16, 2024 •

edited

Loading

jracusin Nov 16, 2024

jracusin Nov 16, 2024

jracusin commented Nov 16, 2024

Vidushi-GitHub commented Dec 2, 2024 •

edited

Loading


		### Working with HEALPix Maps

		HEALPix data is distrubuted in standard format with the file extension `.fits.gz`. These files are FITS image files and can be utilized with many common FITS tools. These files usually stored as HEALPix projection,


		[healpy](https://healpy.readthedocs.io/en/latest/): Official python library for handling the pixlated data on sphere

		[astropy-healpix](https://pypi.org/project/astropy-healpix/)

Healpix doc #2498

Are you sure you want to change the base?

Healpix doc #2498

Conversation

Vidushi-GitHub commented Jul 29, 2024 • edited Loading

Description

lpsinger commented Jul 30, 2024

Vidushi-GitHub Jul 30, 2024

Choose a reason for hiding this comment

lpsinger Aug 2, 2024

Choose a reason for hiding this comment

tylerbarna Oct 7, 2024

Choose a reason for hiding this comment

tylerbarna commented Oct 7, 2024

codecov bot commented Oct 7, 2024 • edited Loading

Codecov Report

Vidushi-GitHub commented Oct 9, 2024

jracusin Nov 16, 2024

Choose a reason for hiding this comment

lpsinger Nov 16, 2024 • edited Loading

Choose a reason for hiding this comment

jracusin Nov 16, 2024

Choose a reason for hiding this comment

jracusin Nov 16, 2024

Choose a reason for hiding this comment

jracusin commented Nov 16, 2024

Vidushi-GitHub commented Dec 2, 2024 • edited Loading

Vidushi-GitHub commented Jul 29, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

lpsinger Nov 16, 2024 •

edited

Loading

Vidushi-GitHub commented Dec 2, 2024 •

edited

Loading