Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: healpy
3 Version: 1.19.0
4 Summary: Healpix tools package for Python
5 Author: A. Zonca
6 Author-email: "C. Rosset" <[email protected]>
7 License: GPL-2.0-only
8 Project-URL: homepage, https://github.com/healpy/healpy
9 Project-URL: source, https://github.com/healpy/healpy
10 Project-URL: download, https://pypi.org/project/healpy/#files
11 Project-URL: changelog, https://github.com/healpy/healpy/blob/main/CHANGELOG.rst
12 Project-URL: releasenotes, https://github.com/healpy/healpy/releases
13 Project-URL: documentation, https://healpy.readthedocs.io
14 Project-URL: issues, https://github.com/healpy/healpy/issues
15 Classifier: Development Status :: 5 - Production/Stable
16 Classifier: Environment :: Console
17 Classifier: Intended Audience :: Science/Research
18 Classifier: Operating System :: POSIX
19 Classifier: Programming Language :: C++
20 Classifier: Programming Language :: Python :: 3.10
21 Classifier: Programming Language :: Python :: 3.11
22 Classifier: Programming Language :: Python :: 3.12
23 Classifier: Programming Language :: Python :: 3.13
24 Classifier: Programming Language :: Python :: 3.14
25 Classifier: Topic :: Scientific/Engineering :: Astronomy
26 Classifier: Topic :: Scientific/Engineering :: Visualization
27 Requires-Python: >=3.10
28 Description-Content-Type: text/x-rst
29 License-File: COPYING
30 Requires-Dist: numpy>=1.19
31 Requires-Dist: astropy
32 Provides-Extra: all
33 Requires-Dist: matplotlib; extra == "all"
34 Requires-Dist: scipy; extra == "all"
35 Provides-Extra: test
36 Requires-Dist: pytest; extra == "test"
37 Requires-Dist: pytest-astropy-header; extra == "test"
38 Requires-Dist: pytest-cython; extra == "test"
39 Requires-Dist: pytest-doctestplus; extra == "test"
40 Requires-Dist: requests; extra == "test"
41 Requires-Dist: matplotlib; extra == "test"
42 Requires-Dist: scipy; extra == "test"
43 Provides-Extra: doc
44 Requires-Dist: ipykernel; extra == "doc"
45 Requires-Dist: matplotlib; extra == "doc"
46 Requires-Dist: nbsphinx; extra == "doc"
47 Requires-Dist: numpydoc; extra == "doc"
48 Requires-Dist: sphinx<9,>=6; extra == "doc"
49 Requires-Dist: scipy; extra == "doc"
50 Dynamic: license-file
51
52 ====================================
53 Healpy, a python wrapper for healpix
54 ====================================
55
56 .. image:: https://badge.fury.io/py/healpy.svg
57 :target: https://badge.fury.io/py/healpy
58
59 .. image:: https://anaconda.org/conda-forge/healpy/badges/version.svg
60 :target: https://anaconda.org/conda-forge/healpy
61
62 .. image:: https://github.com/healpy/healpy/actions/workflows/cibuildwheel.yml/badge.svg
63 :target: https://github.com/healpy/healpy/actions/workflows/cibuildwheel.yml
64
65 .. image:: https://readthedocs.org/projects/healpy/badge/?version=latest
66 :target: https://readthedocs.org/projects/healpy/?badge=latest
67 :alt: Documentation Status
68
69 .. image:: https://mybinder.org/badge_logo.svg
70 :target: https://mybinder.org/v2/gist/zonca/9c114608e0903a3b8ea0bfe41c96f255/master
71
72 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2605425.svg
73 :target: https://doi.org/10.5281/zenodo.2605425
74
75 .. image:: http://joss.theoj.org/papers/10.21105/joss.01298/status.svg
76 :target: https://doi.org/10.21105/joss.01298
77
78 Description
79 -----------
80
81 `healpy` is a Python package to handle pixelated data on the sphere. It is based on the
82 `Hierarchical Equal Area isoLatitude Pixelization (HEALPix) <https://healpix.jpl.nasa.gov/>`_
83 scheme and bundles the `HEALPix` C++ library.
84
85 `HEALPix` was developed to efficiently process Cosmic Microwave Background data from Cosmology
86 experiments like BOOMERANG and WMAP but it is now used in other branches of Astrophysics to
87 store data from all-sky surveys. The target audience used to be primarily the Cosmology
88 scientific community but currently anyone interested in handling pixelated data on the sphere
89 is very welcome to propose new features.
90
91 For an introduction to HEALPix and `healpy`, see `Methods for CMB map analysis <https://arxiv.org/html/2410.12951v2>`_.
92
93 Capabilities
94 ------------
95
96 `healpy` provides utilities to:
97
98 * convert between sky coordinates and pixel indices in `HEALPix` nested and ring schemes
99 * find pixels within a disk, a polygon or a strip in the sky
100 * apply coordinate transformations between Galactic, Ecliptic and Equatorial reference frames
101 * apply custom rotations either to vectors or full maps
102 * read and write `HEALPix` maps to disk in FITS format
103 * upgrade and downgrade the resolution of existing `HEALPix` maps
104 * visualize maps in Mollweide, Gnomonic and Cartographic projections
105 * transform maps to Spherical Harmonics space and back using multi-threaded C++ routines
106 * compute Auto and Cross Power Spectra from maps and create map realizations from spectra
107
108 The documentation can be found at https://healpy.readthedocs.io, tutorial at
109 https://healpy.readthedocs.io/en/latest/tutorial.html, or execute it on `mybinder <https://mybinder.org/v2/gist/zonca/9c114608e0903a3b8ea0bfe41c96f255/master>`_
110
111 Requirements
112 ------------
113
114 * `Python <http://www.python.org>`_ 3.10, 3.11, 3.12, 3.13, or 3.14
115
116 * `Numpy <http://numpy.scipy.org/>`_ (tested with version >=1.19)
117
118 * `Matplotlib <https://matplotlib.org/>`_
119
120 * Python development package is required for some distribution (e.g.,
121 python-dev package for Ubuntu)
122
123 * `Astropy <http://www.astropy.org>`_
124
125 Quick installation with Pip
126 ---------------------------
127
128 The quickest way to install Healpy is with `pip <http://www.pip-installer.org>`_
129 (>= 1.4.2), which automatically fetches the latest version of Healpy and any
130 missing dependencies::
131
132 pip install --user healpy
133
134 If you have installed with ``pip``, you can keep your installation up to date
135 by upgrading from time to time::
136
137 pip install --user --upgrade healpy
138
139 See `INSTALL.rst <https://github.com/healpy/healpy/blob/master/INSTALL.rst>`_
140 for further details and other installation options.
141
142 Optional
143 --------
144
145 Healpy depends on the `HEALPix` C++ and cfitsio C libraries. Source code is
146 include with Healpy and you do not have to install them separately.
147
148 However, if you have them installed already, Healpy should detect and reuse
149 them instead of building them from source. To use your own installations of
150 `HEALPix` and cfitsio, you will also need:
151
152 * `pkg-config <http://pkg-config.freedesktop.org>`_
153
154 * `HEALPix
155 <http://sourceforge.net/projects/healpix/files/Healpix_3.11/autotools_packages/>`_
156 autotools-style C++ package
157
158 * `cfitsio <http://heasarc.gsfc.nasa.gov/fitsio/>`_
159
160 See `INSTALL.rst <https://github.com/healpy/healpy/blob/master/INSTALL.rst>`_
161 for further instructions.
162
163 Known issues
164 ------------
165
166 * Building with OpenMP support: the underlying `HEALPix` C++ library can be built
167 to use `OpenMP <http://openmp.org/wp/>`_ to speed up some operations on
168 systems with multiple cores. Most, but not all, modern C/C++ compilers support
169 OpenMP, `the notable exception being clang <http://openmp.llvm.org>`_.
170
171 If your Healpy build fails with an error message about being unable to link
172 against `-lgomp`, then this typically means that Healpy detected an
173 already-installed `HEALPix` C++ library that was built with OpenMP support, but
174 you are trying to build Healpy with a compiler that does not support OpenMP.
175 Try cleaning the build with `python setup.py clean --all`, and set the
176 environment variables `CC` and `CXX` to point to an OpenMP-capable compiler,
177 such as gcc/g++.
178
179 * Healpy does not currently support Windows.
180 See https://github.com/healpy/healpy/issues/25.
181
182 * Incompatibility with ``cfitisio`` from ``HEASOFT``: due to a conflict of
183 header file names it is currently not possible to use the cfitsio library
184 provided with the HEASOFT package for compilation of `HEALPix` C++. HEASOFT's
185 include directory contains a file called "rotmatrix.h" which clashes with
186 `HEALPix`'s own rotmatrix.h.
187
188 * Compilation problems in the C++ package: some gcc versions (we have reports
189 for 4.4.5 and 4.4.6) crash with an internal compiler error during compilation
190 of libsharp. Unfortunately we have not found a workaround for this compiler
191 problem. To our knowledge, it has been fixed in gcc 4.4.7 and in the 4.5.x
192 and newer versions.
193
194 * Healpy pixel functions, e.g. ``ang2pix``, do not support 32-bit platforms.
195 See https://github.com/healpy/healpy/issues/194.
196
197 Support
198 -------
199
200 For specific *HOWTO* questions please create a question on StackOverflow_ and
201 tag it with the `healpy` tag, so that answers will be easily searchable on
202 google.
203
204 If you think you found a bug or you have install issues, open an issue on GitHub:
205 https://github.com/healpy/healpy/issues
206
207 .. _StackOverflow: http://stackoverflow.com/questions/ask
208
209 Contribute
210 ----------
211
212 Project development takes place on github, http://github.com/healpy/healpy,
213 please open an issue over there for reporting bugs or suggest improvements.
214 Collaboration is very welcome, just fork the project on github and send pull
215 requests back to the main repository.
216
217 Developers
218 ----------
219 Core developers:
220
221 * Cyrille Rosset
222 * Andrea Zonca
223 * Martin Reinecke
224 * Leo Singer
225 * Daniel Lenz
226
227 List of contributors: https://github.com/healpy/healpy/graphs/contributors
228
229 Acknowledgements
230 ----------------
231
232 1. Cite the HEALPix and `healpy` papers, see the `CITATION file <https://github.com/healpy/healpy/blob/master/CITATION>`_ in the repository.
233
234 2. Add an acknowledgment statement: "Some of the results in this paper have been
235 derived using the `healpy` and `HEALPix` packages".
236
237 3. at the first use of the `HEALPix` acronym, a footnote placed in the main body
238 of the paper referring to the `HEALPix` web site, currently
239 http://healpix.sf.net