Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Healpix doc #2498

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Healpix doc #2498

wants to merge 13 commits into from

Conversation

Vidushi-GitHub
Copy link
Member

@Vidushi-GitHub Vidushi-GitHub commented Jul 29, 2024

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
Copy link
Member

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 Outdated Show resolved Hide resolved
Vidushi-GitHub and others added 4 commits July 30, 2024 10:12
previous commits had hyperlink brackets/parentheses used incorrectly
recreate lost content
hp_index = np.argmax(skymap['PROBDENSITY'])
uniq = skymap[hq_index]['UNIQ']

level, ipix = ah.uniq_to_level_ipix(uniq)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should introduce a UNIQ scheme a bit.

Comment on lines 353 to 365
(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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use DOIs for all paper URLs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

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

Copy link

codecov bot commented Oct 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.09%. Comparing base (46ec6cc) to head (569e18c).
Report is 80 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##            main   #2498      +/-   ##
========================================
+ Coverage   5.27%   6.09%   +0.81%     
========================================
  Files        157     164       +7     
  Lines       3906    4072     +166     
  Branches     419     450      +31     
========================================
+ Hits         206     248      +42     
- Misses      3699    3822     +123     
- Partials       1       2       +1     

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

@dakota002 dakota002 marked this pull request as ready for review October 9, 2024 16:29
@Vidushi-GitHub
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add documentation on parsing and using HEALPix maps
3 participants