Skip to content

Commit aa0e3ef

Browse files
authored
gh-1034: Expose glass.healpix module (#1035)
1 parent 47371b1 commit aa0e3ef

File tree

4 files changed

+37
-3
lines changed

4 files changed

+37
-3
lines changed

.github/ISSUE_TEMPLATE/documentation.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ body:
1616
attributes:
1717
label: What Can be Improved About This Section
1818
description: Is it incomplete, incorrect or difficult to understand?
19-
validations:
20-
required: true
2119
- id: suggestions
2220
type: textarea
2321
attributes:

docs/modules/healpix.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. module:: glass.healpix
2+
3+
:mod:`glass.healpix` --- Array API compatible HEALPix functions
4+
===============================================================
5+
6+
.. currentmodule:: glass.healpix
7+
8+
This module contains functions for working with HEALPix maps in an Array API
9+
compliant manner used with GLASS.
10+
11+
This module should be imported manually if used outside of GLASS::
12+
13+
import glass.healpix as hp
14+
15+
``healpix`` Functions
16+
---------------------
17+
18+
.. autofunction:: ang2pix
19+
.. autofunction:: ang2vec
20+
.. autofunction:: npix2nside
21+
.. autofunction:: nside2npix
22+
.. autofunction:: randang
23+
24+
``healpy`` Functions
25+
--------------------
26+
27+
.. autofunction:: alm2map
28+
.. autofunction:: alm2map_spin
29+
.. autofunction:: almxfl
30+
.. autofunction:: get_nside
31+
.. autofunction:: map2alm
32+
.. autofunction:: pixwin
33+
.. autofunction:: query_strip
34+
.. automethod:: Rotator.rotate_map_pixel

docs/modules/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ Modules
99
arraytools
1010
grf
1111
harmonics
12+
healpix

glass/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"glass_to_healpix_spectra",
4242
"grf",
4343
"harmonics",
44+
"healpix",
4445
"healpix_to_glass_spectra",
4546
"iternorm",
4647
"linear_bias",
@@ -79,7 +80,7 @@
7980
from ._version import __version__
8081

8182
# modules
82-
from glass import algorithm, arraytools, grf, harmonics
83+
from glass import algorithm, arraytools, grf, harmonics, healpix
8384
from glass.fields import (
8485
check_posdef_spectra,
8586
cls2cov,

0 commit comments

Comments
 (0)