Improve docs

README.md

@@ -1,3 +1,4 @@
+<img src="logo.png" width="100"> 
 # Pynkowski
 
 A Python package to compute Minkowski Functionals and other higher order statistics of input fields, as well as their expected values for different kinds of fields.
@@ -10,17 +11,17 @@ The statistics currently supported by this package are:
 The formats currently supported for **input data** are the following:
 
 - Scalar HEALPix maps, as the ones used by [healpy](https://healpy.readthedocs.io/), such as $T, \kappa, P^2$ (see [paper 1](https://arxiv.org/abs/2211.07562)).
-- Polarisation HEALPix maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
+- Polarisation HEALPix maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
 - 2D and 3D numpy arrays (coming soon).
 
 The theoretical expectation of some statistics is currently supported for the following **theoretical fields**:
 
 - Gaussian fields (such as CMB $T$ or the initial density field, see [paper 1](https://arxiv.org/abs/2211.07562)).
 - $\chi^2$ fields (such as CMB $P^2$, see [paper 1](https://arxiv.org/abs/2211.07562)).
-- Spin 2 maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
+- Spin 2 maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
 
 We are actively working on the implementation of more statistics, data formats, and theoretical fields. If you want to contribute, we welcome and appreciate pull requests. 
-If you have any comments or suggestions, please feel free to contact us by email ([1](mailto:javier.carron@roma2.infn.it) and [2](mailto:[email protected] )) or by opening a discussion thread or issue.
+If you have any comments or suggestions, please feel free to contact us by email ([1](mailto:javier.carron@csic.es) and [2](mailto:[email protected] )) or by opening a discussion thread or issue.
 
 The repository can be found on [https://github.com/javicarron/pynkowski](https://github.com/javicarron/pynkowski).
 
@@ -51,12 +52,14 @@ This package is divided into three modules: `stats`, `data`, and `theory`. Each
 
 - [`data`](https://javicarron.github.io/pynkowski/pynkowski/data.html)
  - [`base_da`](https://javicarron.github.io/pynkowski/pynkowski/data/base_da.html)
+ - [`array`](https://javicarron.github.io/pynkowski/pynkowski/data/array.html)
  - [`healpix`](https://javicarron.github.io/pynkowski/pynkowski/data/healpix.html)
  - [`utils_da`](https://javicarron.github.io/pynkowski/pynkowski/data/utils_da.html)
 
 - [`theory`](https://javicarron.github.io/pynkowski/pynkowski/theory.html)
  - [`base_th`](https://javicarron.github.io/pynkowski/pynkowski/theory/base_th.html)
  - [`gaussian`](https://javicarron.github.io/pynkowski/pynkowski/theory/gaussian.html)
+ - [`spingaussian`](https://javicarron.github.io/pynkowski/pynkowski/theory/spingaussian.html)
  - [`chi2`](https://javicarron.github.io/pynkowski/pynkowski/theory/chi2.html)
  - [`utils_th`](https://javicarron.github.io/pynkowski/pynkowski/theory/utils_th.html)
 

pynkowski/__init__.py

@@ -10,17 +10,17 @@
 The formats currently supported for **input data** are the following:
 
 - Scalar HEALPix maps, as the ones used by [healpy](https://healpy.readthedocs.io/), such as $T, \kappa, P^2$ (see [paper 1](https://arxiv.org/abs/2211.07562)).
-- Polarisation HEALPix maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
+- Polarisation HEALPix maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
 - 2D and 3D numpy arrays (coming soon).
 
 The theoretical expectation of some statistics is currently supported for the following **theoretical fields**:
 
 - Gaussian fields (such as CMB $T$ or the initial density field, see [paper 1](https://arxiv.org/abs/2211.07562)).
 - $\chi^2$ fields (such as CMB $P^2$, see [paper 1](https://arxiv.org/abs/2211.07562)).
-- Spin 2 maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
+- Spin 2 maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
 
 We are actively working on the implementation of more statistics, data formats, and theoretical fields. If you want to contribute, we welcome and appreciate pull requests. 
-If you have any comments or suggestions, please feel free to contact us by email ([1](mailto:javier.carron@roma2.infn.it) and [2](mailto:[email protected] )) or by opening a discussion thread or issue.
+If you have any comments or suggestions, please feel free to contact us by email ([1](mailto:javier.carron@csic.es) and [2](mailto:[email protected] )) or by opening a discussion thread or issue.
 
 The repository can be found on [https://github.com/javicarron/pynkowski](https://github.com/javicarron/pynkowski).
 
@@ -58,6 +58,7 @@
 - [`theory`](https://javicarron.github.io/pynkowski/pynkowski/theory.html)
  - [`base_th`](https://javicarron.github.io/pynkowski/pynkowski/theory/base_th.html)
  - [`gaussian`](https://javicarron.github.io/pynkowski/pynkowski/theory/gaussian.html)
+ - [`spingaussian`](https://javicarron.github.io/pynkowski/pynkowski/theory/spingaussian.html)
  - [`chi2`](https://javicarron.github.io/pynkowski/pynkowski/theory/chi2.html)
  - [`utils_th`](https://javicarron.github.io/pynkowski/pynkowski/theory/utils_th.html)
 
@@ -84,7 +85,7 @@
 from .theory import (TheoryField,
  Gaussian,
  SphericalGaussian,
- EuclideanGaussian,
+ #  EuclideanGaussian,
  SpinGaussian,
  Chi2,
  SphericalChi2)