-
Notifications
You must be signed in to change notification settings - Fork 43
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
base: main
Are you sure you want to change the base?
Healpix doc #2498
Conversation
Please fix the following build error:
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 (```). |
Co-authored-by: Leo Singer <[email protected]>
previous commits had hyperlink brackets/parentheses used incorrectly
recreate lost content
app/routes/docs.notices.healpix.mdx
Outdated
hp_index = np.argmax(skymap['PROBDENSITY']) | ||
uniq = skymap[hq_index]['UNIQ'] | ||
|
||
level, ipix = ah.uniq_to_level_ipix(uniq) |
There was a problem hiding this comment.
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.
this relocates the documentation into the sample code page under the kafka client setup
app/routes/docs.client.samples.md
Outdated
(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) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
Is there a reason why we still have this marked as a draft? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Following #2035, two points are still incomplete: |
Description
Add document for parsing and using HEALPix docs
Explaining what it represents, how one can understand a skymap
Resolves: #2035