You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,5 @@
1
+
<imgsrc="logo.png"width="100">
2
+
1
3
# Pynkowski
2
4
3
5
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 +12,17 @@ The statistics currently supported by this package are:
10
12
The formats currently supported for **input data** are the following:
11
13
12
14
- 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)).
13
-
- Polarisation HEALPix maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
15
+
- Polarisation HEALPix maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
14
16
- 2D and 3D numpy arrays (coming soon).
15
17
16
18
The theoretical expectation of some statistics is currently supported for the following **theoretical fields**:
17
19
18
20
- Gaussian fields (such as CMB $T$ or the initial density field, see [paper 1](https://arxiv.org/abs/2211.07562)).
19
21
- $\chi^2$ fields (such as CMB $P^2$, see [paper 1](https://arxiv.org/abs/2211.07562)).
20
-
- Spin 2 maps in the $SO(3)$ formalism (coming soon, see [paper 2](https://arxiv.org/abs/2301.13191)).
22
+
- Spin 2 maps in the $SO(3)$ formalism (see [paper 2](https://arxiv.org/abs/2301.13191)).
21
23
22
24
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.
23
-
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.
25
+
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.
24
26
25
27
The repository can be found on [https://github.com/javicarron/pynkowski](https://github.com/javicarron/pynkowski).
26
28
@@ -51,12 +53,14 @@ This package is divided into three modules: `stats`, `data`, and `theory`. Each
<divclass="docstring"><p>This module contains all the classes to work with data in several conventions. Currently, the implemented formats are the following:</p>
79
81
80
82
<ul>
81
-
<li><ahref="data/base_da.html"><code>base_da</code></a>: the abstract class for general data fields, to be used as the base for the other fields.</li>
83
+
<li><ahref="data/base_da.html"><code>base_da</code></a>: the base class for data fields, to be used as the base for the other fields.</li>
84
+
<li><ahref="data/array.html"><code>array</code></a>: fields in the form of numpy arrays of arbitrary dimension, typically used for 2D or 3D maps.</li>
82
85
<li><p><ahref="data/healpix.html"><code>healpix</code></a>: scalar maps on the sphere in the healpix convention. An optional interface for $P^2$ is included.</p></li>
83
86
<li><p>There is also a general utilities submodule called <ahref="data/utils_da.html"><code>utils_da</code></a>.</p></li>
84
87
</ul>
@@ -90,23 +93,26 @@ <h1 class="modulename">
90
93
91
94
<divclass="pdoc-code codehilite"><pre><span></span><spanid="L-1"><ahref="#L-1"><spanclass="linenos"> 1</span></a><spanclass="sd">'''This module contains all the classes to work with data in several conventions. Currently, the implemented formats are the following:</span>
</span><spanid="L-3"><ahref="#L-3"><spanclass="linenos"> 3</span></a><spanclass="sd">- [`base_da`](data/base_da.html): the abstract class for general data fields, to be used as the base for the other fields.</span>
94
-
</span><spanid="L-4"><ahref="#L-4"><spanclass="linenos"> 4</span></a><spanclass="sd">- [`healpix`](data/healpix.html): scalar maps on the sphere in the healpix convention. An optional interface for $P^2$ is included.</span>
</span><spanid="L-6"><ahref="#L-6"><spanclass="linenos"> 6</span></a><spanclass="sd">- There is also a general utilities submodule called [`utils_da`](data/utils_da.html).</span>
</span><spanid="L-16"><ahref="#L-16"><spanclass="linenos">16</span></a><spanclass="nb">print</span><spanclass="p">(</span><spanclass="s2">"healpy was not loaded, some functionality will be unavailable"</span><spanclass="p">)</span>
</span><spanid="L-3"><ahref="#L-3"><spanclass="linenos"> 3</span></a><spanclass="sd">- [`base_da`](data/base_da.html): the base class for data fields, to be used as the base for the other fields.</span>
97
+
</span><spanid="L-4"><ahref="#L-4"><spanclass="linenos"> 4</span></a><spanclass="sd">- [`array`](data/array.html): fields in the form of numpy arrays of arbitrary dimension, typically used for 2D or 3D maps.</span>
98
+
</span><spanid="L-5"><ahref="#L-5"><spanclass="linenos"> 5</span></a><spanclass="sd">- [`healpix`](data/healpix.html): scalar maps on the sphere in the healpix convention. An optional interface for $P^2$ is included.</span>
</span><spanid="L-7"><ahref="#L-7"><spanclass="linenos"> 7</span></a><spanclass="sd">- There is also a general utilities submodule called [`utils_da`](data/utils_da.html).</span>
</span><spanid="L-19"><ahref="#L-19"><spanclass="linenos">19</span></a><spanclass="nb">print</span><spanclass="p">(</span><spanclass="s2">"healpy was not loaded, some functionality will be unavailable"</span><spanclass="p">)</span>
0 commit comments