README.md 4.58 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
NIFTy - Numerical Information Field Theory
Jait Dixit's avatar
Jait Dixit committed
2
==========================================
Martin Reinecke's avatar
Martin Reinecke committed
3 4
[![build status](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/NIFTy_4/build.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/NIFTy_4)
[![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/NIFTy_4/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/NIFTy_4)
Jait Dixit's avatar
Jait Dixit committed
5

Martin Reinecke's avatar
Martin Reinecke committed
6
**NIFTy** project homepage:
Jait Dixit's avatar
Jait Dixit committed
7 8 9 10 11 12 13
[http://www.mpa-garching.mpg.de/ift/nifty/](http://www.mpa-garching.mpg.de/ift/nifty/)

Summary
-------

### Description

Martin Reinecke's avatar
Martin Reinecke committed
14
**NIFTy**, "**N**umerical **I**nformation **F**ield **T**heor<strong>y</strong>", is
Jait Dixit's avatar
Jait Dixit committed
15 16 17
a versatile library designed to enable the development of signal
inference algorithms that operate regardless of the underlying spatial
grid and its resolution. Its object-oriented framework is written in
Martin Reinecke's avatar
updates  
Martin Reinecke committed
18
Python, although it accesses libraries written in C++ and C for
Jait Dixit's avatar
Jait Dixit committed
19 20
efficiency.

Martin Reinecke's avatar
Martin Reinecke committed
21
NIFTy offers a toolkit that abstracts discretized representations of
Jait Dixit's avatar
Jait Dixit committed
22
continuous spaces, fields in these spaces, and operators acting on
Martin Reinecke's avatar
Martin Reinecke committed
23
fields into classes. The correct normalization of operations on
Jait Dixit's avatar
Jait Dixit committed
24 25 26
fields is taken care of automatically without concerning the user. This
allows for an abstract formulation and programming of inference
algorithms, including those derived within information field theory.
Martin Reinecke's avatar
Martin Reinecke committed
27
Thus, NIFTy permits its user to rapidly prototype algorithms in 1D, and
Jait Dixit's avatar
Jait Dixit committed
28
then apply the developed code in higher-dimensional settings of real
Martin Reinecke's avatar
Martin Reinecke committed
29
world problems. The set of spaces on which NIFTy operates comprises
Jait Dixit's avatar
Jait Dixit committed
30 31 32 33 34 35
point sets, *n*-dimensional regular grids, spherical spaces, their
harmonic counterparts, and product spaces constructed as combinations of
those.

### Class & Feature Overview

Martin Reinecke's avatar
Martin Reinecke committed
36 37
The NIFTy library features three main classes: **Space**s that represent
certain grids, **Field**s that are defined on spaces, and **LinearOperator**s
Jait Dixit's avatar
Jait Dixit committed
38 39 40
that apply to fields.

-   [Spaces](http://www.mpa-garching.mpg.de/ift/nifty/space.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
41 42 43 44
    -   `RGSpace` - *n*-dimensional regular Euclidean grid
    -   `LMSpace` - spherical harmonics
    -   `GLSpace` - Gauss-Legendre grid on the 2-sphere
    -   `HPSpace` - [HEALPix](http://sourceforge.net/projects/healpix/)
Jait Dixit's avatar
Jait Dixit committed
45 46
        grid on the 2-sphere
-   [Fields](http://www.mpa-garching.mpg.de/ift/nifty/field.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
47
    -   `Field` - generic class for (discretized) fields
Jait Dixit's avatar
Jait Dixit committed
48 49 50

<!-- -->

Martin Reinecke's avatar
updates  
Martin Reinecke committed
51
    Field.conjugate     Field.dim          Field.norm
Martin Reinecke's avatar
Martin Reinecke committed
52
    Field.vdot          Field.weight
Jait Dixit's avatar
Jait Dixit committed
53 54

-   [Operators](http://www.mpa-garching.mpg.de/ift/nifty/operator.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
55
    -   `DiagonalOperator` - purely diagonal matrices in a specified
Jait Dixit's avatar
Jait Dixit committed
56
        basis
Martin Reinecke's avatar
Martin Reinecke committed
57 58
    -   `FFTOperator` - conversion between spaces and their harmonic
                        counterparts
Jait Dixit's avatar
Jait Dixit committed
59 60 61 62 63 64 65 66
    -   (and more)
-   (and more)

Installation
------------

### Requirements

Martin Reinecke's avatar
update  
Martin Reinecke committed
67
-   [Python](http://www.python.org/) (v2.7.x or 3.5.x)
Martin Reinecke's avatar
Martin Reinecke committed
68 69 70 71 72
-   [NumPy](http://www.numpy.org/)

Optional dependencies:
-   [pyFFTW](https://pypi.python.org/pypi/pyFFTW)
-   [pyHealpix](https://gitlab.mpcdf.mpg.de/ift/pyHealpix)
Martin Reinecke's avatar
Martin Reinecke committed
73
-   [mpi4py](https://mpi4py.scipy.org)
Jait Dixit's avatar
Jait Dixit committed
74

Martin Reinecke's avatar
Martin Reinecke committed
75
### Sources
Jait Dixit's avatar
Jait Dixit committed
76

Martin Reinecke's avatar
updates  
Martin Reinecke committed
77
The current version of Nifty3 can be obtained by cloning the repository:
Jait Dixit's avatar
Jait Dixit committed
78 79 80 81

    git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git


Martin Reinecke's avatar
Martin Reinecke committed
82
### Installation via pip
Jait Dixit's avatar
Jait Dixit committed
83

Martin Reinecke's avatar
Martin Reinecke committed
84
It is possible to simply install NIFTy with all its dependencies via the command
Jait Dixit's avatar
Jait Dixit committed
85

Martin Reinecke's avatar
Martin Reinecke committed
86
pip install --user --process-dependency-links --egg git+https://gitlab.mpcdf.mpg.de/ift/NIFTy.git@nifty4
Jait Dixit's avatar
Jait Dixit committed
87

Theo Steininger's avatar
Theo Steininger committed
88 89 90 91
### Running the tests

In oder to run the tests one needs two additional packages:

Martin Reinecke's avatar
Martin Reinecke committed
92
    pip install nose parameterized
93 94

Afterwards the tests (including a coverage report) are run using the following
Theo Steininger's avatar
Theo Steininger committed
95
command in the repository root:
96

Martin Reinecke's avatar
Martin Reinecke committed
97
    nosetests -x --with-coverage --cover-html --cover-package=nifty4
Theo Steininger's avatar
Theo Steininger committed
98 99


Jait Dixit's avatar
Jait Dixit committed
100 101
### First Steps

Martin Reinecke's avatar
Martin Reinecke committed
102
For a quick start, you can browse through the [informal
Jait Dixit's avatar
Jait Dixit committed
103
introduction](http://www.mpa-garching.mpg.de/ift/nifty/start.html) or
Martin Reinecke's avatar
Martin Reinecke committed
104
dive into NIFTy by running one of the demonstrations, e.g.:
Jait Dixit's avatar
Jait Dixit committed
105

Martin Reinecke's avatar
Martin Reinecke committed
106
    python demos/wiener_filter_via_curvature.py
Jait Dixit's avatar
Jait Dixit committed
107 108 109 110

Acknowledgement
---------------

Martin Reinecke's avatar
Martin Reinecke committed
111
Please acknowledge the use of NIFTy in your publication(s) by using a
Jait Dixit's avatar
Jait Dixit committed
112 113 114
phrase such as the following:

> *"Some of the results in this publication have been derived using the
Martin Reinecke's avatar
Martin Reinecke committed
115
> NIFTy package [Selig et al., 2013]."*
Jait Dixit's avatar
Jait Dixit committed
116 117 118 119 120 121

### References

Release Notes
-------------

Martin Reinecke's avatar
Martin Reinecke committed
122
The NIFTy package is licensed under the terms of the
Jait Dixit's avatar
Jait Dixit committed
123 124 125 126 127
[GPLv3](http://www.gnu.org/licenses/gpl.html) and is distributed
*without any warranty*.

* * * * *

Martin Reinecke's avatar
Martin Reinecke committed
128
**NIFTy** project homepage:
Jait Dixit's avatar
Jait Dixit committed
129 130
[](http://www.mpa-garching.mpg.de/ift/nifty/)

Martin Reinecke's avatar
Martin Reinecke committed
131
[1] Selig et al., "NIFTy - Numerical Information Field Theory - a
Jait Dixit's avatar
Jait Dixit committed
132 133
versatile Python library for signal inference", [A&A, vol. 554, id.
A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013;
134
[arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499)