README.md 6.73 KB
Newer Older
1
2
3
4
5
6
7
8
9
WARNING:
========

The code on this branch is not meant to be an official version of NIFTy.
As a consequence, it does not install as package "nifty", but rather as
"nifty2go", to allow parallel installation alongside the official NIFTy and
avoid any conflicts.


Jait Dixit's avatar
Jait Dixit committed
10
11
12
13
14
15
16
17
18
19
20
21
22
NIFTY - Numerical Information Field Theory
==========================================
[![build status](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/master/build.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/master)
[![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/master/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/master)

**NIFTY** project homepage:
[http://www.mpa-garching.mpg.de/ift/nifty/](http://www.mpa-garching.mpg.de/ift/nifty/)

Summary
-------

### Description

23
**NIFTY**, "**N**umerical **I**nformation **F**ield **T**heor<strong>y</strong>", is
Jait Dixit's avatar
Jait Dixit committed
24
25
26
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
27
Python, although it accesses libraries written in C++ and C for
Jait Dixit's avatar
Jait Dixit committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
efficiency.

NIFTY offers a toolkit that abstracts discretized representations of
continuous spaces, fields in these spaces, and operators acting on
fields into classes. Thereby, the correct normalization of operations on
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.
Thus, NIFTY permits its user to rapidly prototype algorithms in 1D, and
then apply the developed code in higher-dimensional settings of real
world problems. The set of spaces on which NIFTY operates comprises
point sets, *n*-dimensional regular grids, spherical spaces, their
harmonic counterparts, and product spaces constructed as combinations of
those.

### Class & Feature Overview

The NIFTY library features three main classes: **spaces** that represent
certain grids, **fields** that are defined on spaces, and **operators**
that apply to fields.

-   [Spaces](http://www.mpa-garching.mpg.de/ift/nifty/space.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
50
51
52
53
    -   `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
54
55
        grid on the 2-sphere
-   [Fields](http://www.mpa-garching.mpg.de/ift/nifty/field.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
56
    -   `Field` - generic class for (discretized) fields
Jait Dixit's avatar
Jait Dixit committed
57
58
59

<!-- -->

Martin Reinecke's avatar
updates  
Martin Reinecke committed
60
    Field.conjugate     Field.dim          Field.norm
Martin Reinecke's avatar
update  
Martin Reinecke committed
61
    Field.vdot          Field.set_val      Field.weight
Jait Dixit's avatar
Jait Dixit committed
62
63

-   [Operators](http://www.mpa-garching.mpg.de/ift/nifty/operator.html)
Martin Reinecke's avatar
updates  
Martin Reinecke committed
64
    -   `DiagonalOperator` - purely diagonal matrices in a specified
Jait Dixit's avatar
Jait Dixit committed
65
        basis
Martin Reinecke's avatar
updates  
Martin Reinecke committed
66
    -   `ProjectionOperator` - projections onto subsets of a specified
Jait Dixit's avatar
Jait Dixit committed
67
68
69
70
71
72
73
74
75
76
77
78
        basis
    -   (and more)
-   (and more)

*Parts of this summary are taken from* [1] *without marking them
explicitly as quotations.*

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

### Requirements

Martin Reinecke's avatar
update  
Martin Reinecke committed
79
-   [Python](http://www.python.org/) (v2.7.x or 3.5.x)
Jait Dixit's avatar
Jait Dixit committed
80
81
82
83
    -   [NumPy](http://www.numpy.org/)

### Download

Martin Reinecke's avatar
updates  
Martin Reinecke committed
84
The current version of Nifty3 can be obtained by cloning the repository:
Jait Dixit's avatar
Jait Dixit committed
85
86
87
88
89
90
91
92
93
94
95
96

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

### Installation on Ubuntu

This is for you if you want to install NIFTy on your personal computer
running with an Ubuntu-like linux system were you have root priviledges.
Starting with a fresh Ubuntu installation move to a folder like
`~/Downloads`:

-   Install basic packages like python, python-dev, gsl and others:

Martin Reinecke's avatar
Martin Reinecke committed
97
        sudo apt-get install curl git autoconf libtool python-dev python-pip python-numpy
Jait Dixit's avatar
Jait Dixit committed
98

99
-   Install pyHealpix:
Jait Dixit's avatar
Jait Dixit committed
100

Martin Reinecke's avatar
Martin Reinecke committed
101
        git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
Martin Reinecke's avatar
Martin Reinecke committed
102
        (cd pyHealpix && autoreconf -i && ./configure --prefix=$HOME/.local --enable-openmp --enable-native-optimizations && make -j4 install)
Jait Dixit's avatar
Jait Dixit committed
103
104
105
106

-   Finally, NIFTy:

        git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git
Martin Reinecke's avatar
Martin Reinecke committed
107
        (cd NIFTy && python setup.py install --user)
Jait Dixit's avatar
Jait Dixit committed
108

Martin Reinecke's avatar
updates  
Martin Reinecke committed
109
### Installation on Linux systems in general
Jait Dixit's avatar
Jait Dixit committed
110

Martin Reinecke's avatar
updates  
Martin Reinecke committed
111
112
113
114
115
116
Since all the "unconventional" packages (i.e. pyHealpix and NIFTy) listed in the
section above are installed
within the home directory of the user, the installation instructions for these
should also work on any Linux machine where you do not have root access.
In this case you have to ensure with your system administrators that the
"standard" dependencies (python, numpy, etc.) are installed system-wide.
117

Jait Dixit's avatar
Jait Dixit committed
118
119
### Installation on OS X 10.11

120
We advise to install the following packages in the order as they appear
Jait Dixit's avatar
Jait Dixit committed
121
122
123
124
125
126
below. We strongly recommend to install all needed packages via
MacPorts. Please be aware that not all packages are available on
MacPorts, missing ones need to be installed manually. It may also be
mentioned that one should only use one package manager, as multiple ones
may cause trouble.

Martin Reinecke's avatar
updates  
Martin Reinecke committed
127
-   Install numpy:
Jait Dixit's avatar
Jait Dixit committed
128
129
130

        sudo port install py27-numpy

131
-   Install pyHealpix:
Jait Dixit's avatar
Jait Dixit committed
132

Martin Reinecke's avatar
Martin Reinecke committed
133
        git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
134
        cd pyHealpix
135
        autoreconf -i && ./configure --prefix=`python-config --prefix` --enable-openmp --enable-native-optimizations && make -j4 && sudo make install
Jait Dixit's avatar
Jait Dixit committed
136
137
        cd ..

Martin Reinecke's avatar
updates  
Martin Reinecke committed
138
139
140
141
    (The third command installs the package system-wide. User-specific
    installation would be preferrable, but we haven't found a simple recipe yet
    how to determine the installation prefix ...)

Jait Dixit's avatar
Jait Dixit committed
142
143
144
-   Install NIFTy:

        git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git
Martin Reinecke's avatar
Martin Reinecke committed
145
        (cd NIFTy && python setup.py install --user)
Jait Dixit's avatar
Jait Dixit committed
146

Theo Steininger's avatar
Theo Steininger committed
147
148
149
150
### Running the tests

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

Martin Reinecke's avatar
Martin Reinecke committed
151
    pip install nose parameterized
152
153

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

Theo Steininger's avatar
Theo Steininger committed
156
157
158
    nosetests --exe --cover-html


Jait Dixit's avatar
Jait Dixit committed
159
160
161
162
163
164
### First Steps

For a quickstart, you can browse through the [informal
introduction](http://www.mpa-garching.mpg.de/ift/nifty/start.html) or
dive into NIFTY by running one of the demonstrations, e.g.:

165
    python demos/wiener_filter.py
Jait Dixit's avatar
Jait Dixit committed
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

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

Please, acknowledge the use of NIFTY in your publication(s) by using a
phrase such as the following:

> *"Some of the results in this publication have been derived using the
> NIFTY package [Selig et al., 2013]."*

### References

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

The NIFTY package is licensed under the
[GPLv3](http://www.gnu.org/licenses/gpl.html) and is distributed
*without any warranty*.

* * * * *

**NIFTY** project homepage:
[](http://www.mpa-garching.mpg.de/ift/nifty/)

[1] Selig et al., "NIFTY - Numerical Information Field Theory - a
versatile Python library for signal inference", [A&A, vol. 554, id.
A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013;
193
[arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499)