Metadata-Version: 2.3
Name: heracles
Version: 24.1.1
Summary: Harmonic-space statistics on the sphere
Project-URL: Documentation, https://heracles.readthedocs.io/
Project-URL: Homepage, https://github.com/heracles-ec/heracles
Project-URL: Issues, https://github.com/heracles-ec/heracles/issues
Author-email: Nicolas Tessore <n.tessore@ucl.ac.uk>
License-Expression: LGPL-3.0-or-later
License-File: COPYING
License-File: COPYING.LESSER
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Requires-Dist: convolvecl
Requires-Dist: coroutines
Requires-Dist: fitsio
Requires-Dist: healpy
Requires-Dist: numba
Requires-Dist: numpy
Provides-Extra: all
Requires-Dist: ducc0; extra == 'all'
Requires-Dist: rich; extra == 'all'
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: ipython; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Requires-Dist: numpydoc; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinxcontrib-katex; extra == 'docs'
Provides-Extra: test
Requires-Dist: ducc0; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-rerunfailures; extra == 'test'
Description-Content-Type: text/markdown

# _Heracles_ — Harmonic-space statistics on the sphere

[![PyPI](https://img.shields.io/pypi/v/heracles)](https://pypi.org/project/heracles)
[![Python](https://img.shields.io/pypi/pyversions/heracles)](https://www.python.org)
[![Documentation](https://readthedocs.org/projects/heracles/badge/?version=latest)](https://heracles.readthedocs.io/en/latest/?badge=latest)
[![arXiv](https://img.shields.io/badge/arXiv-2408.16903-red)](https://arxiv.org/abs/2408.16903)
[![NASA/ADS](https://img.shields.io/badge/ads-2024arXiv240816903E-blueviolet)](https://ui.adsabs.harvard.edu/abs/2024arXiv240816903E)
[![DOI](https://img.shields.io/badge/doi-10.48550/arXiv.2408.16903-blue)](https://doi.org/10.48550/arXiv.2408.16903)
[![Tests](https://github.com/heracles-ec/heracles/actions/workflows/tests.yml/badge.svg)](https://github.com/heracles-ec/heracles/actions/workflows/tests.yml)
[![Coverage](https://coveralls.io/repos/github/heracles-ec/heracles/badge.svg?branch=main)](https://coveralls.io/github/heracles-ec/heracles?branch=main)

This is _Heracles_, a code for harmonic-space statistics on the sphere.
_Heracles_ can take catalogues of positions a function values on the sphere and
turn them into wonderful things like angular power spectra and mixing matrices.

To get started, read the [documentation](https://heracles.readthedocs.io).

🛰️ **Made in the Euclid Science Ground Segment**

## Installation (latest)

To install the latest released version of the package:

    pip install heracles

You should do this in a dedicated environment (conda, venv, etc.)

## Installation (git main)

To install the latest unreleased version from the git main branch:

    pip install git+https://github.com/heracles-ec/heracles.git

## Installation (develop)

Clone the repository, cd into the local copy, then install in editable mode:

    pip install -e .
