# pynkowski

# Welcome to Pynkowski's documentation!

A Python package to compute Minkowski Functionals of input fields, as well as their expected values in the case of Gaussian isotropic fields.

The formats supported for input data are the following:

- Scalar HEALPix maps, as the ones used by healpy (see paper).

...and more to come, feel free to contact us (by email or opening an issue) to implement more schemes.

The theoretical expectation for Gaussian isotropic fields are implemented in the following cases:

- Gaussian scalar maps on the sphere (such as CMB $T$, see paper).
- $\chi^2$ maps on the sphere (such as CMB $P^2$, see paper).

...and more to come, feel free to contact us (by email or opening an issue) to implement more theoretical expectations.

The repository can be found on https://github.com/javicarron/pynkowski.

## Installation

This package can be installed with:

    pip install pynkowski

The dependencies are:

- numpy
- scipy
- healpy
- tqdm (optional, notebook only)

## Documentation

The documentation can be found on https://javicarron.github.io/pynkowski

## Example notebooks

- Get the Minkowski Functionals of a CMB temperature $T$ map and compare with theory.
- Get the Minkowski Functionals of a CMB polarization $P^2=Q^2+U^2$ map and compare with theory (coming soon).

## Authors

This package has been developed by Javier Carrón Duque and Alessandro Carones.

View Source

     1'''# Welcome to Pynkowski's documentation!
     2
     3A Python package to compute Minkowski Functionals of input fields, as well as their expected values in the case of Gaussian isotropic fields.
     4
     5The formats supported for **input data** are the following:
     6- Scalar HEALPix maps, as the ones used by [healpy](https://healpy.readthedocs.io/) (see paper).
     7
     8...and more to come, feel free to contact us (by [email](mailto:javier.carron@roma2.infn.it) or opening an issue) to implement more schemes.
     9
    10
    11The **theoretical expectation** for Gaussian isotropic fields are implemented in the following cases:
    12- Gaussian scalar maps on the sphere (such as CMB $T$, see paper).
    13- $\chi^2$ maps on the sphere (such as CMB $P^2$, see paper).
    14
    15...and more to come, feel free to contact us (by [email](mailto:javier.carron@roma2.infn.it) or opening an issue) to implement more theoretical expectations.
    16
    17The repository can be found on [https://github.com/javicarron/pynkowski](https://github.com/javicarron/pynkowski).
    18
    19## Installation
    20
    21This package can be installed with:
    22```
    23pip install pynkowski
    24```
    25
    26The dependencies are:
    27- [numpy](https://numpy.org/)
    28- [scipy](https://scipy.org/)
    29- [healpy](https://healpy.readthedocs.io/)
    30- [tqdm](https://github.com/tqdm/tqdm) (optional, notebook only)
    31
    32## Documentation
    33
    34The documentation can be found on <https://javicarron.github.io/pynkowski>
    35
    36## Example notebooks
    37
    38- [Get the Minkowski Functionals of a CMB temperature $T$ map and compare with theory](https://github.com/javicarron/pynkowski/blob/main/examples/Temperature.ipynb).
    39- Get the Minkowski Functionals of a CMB polarization $P^2=Q^2+U^2$ map and compare with theory (coming soon).
    40
    41
    42## Authors
    43
    44This package has been developed by [Javier Carrón Duque](https:www.javiercarron.com) and Alessandro Carones.
    45'''
    46
    47from .data import Scalar
    48
    49from .theory import (get_μ,
    50                     TheoryTemperature,
    51                     TheoryP2)
    52
    53from .__version import __version__
    54
    55
    56
    57
    58__docformat__ = "numpy"