README.md 4.45 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_5/build.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/NIFTy_5)
[![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/NIFTy_5/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/NIFTy_5)
Jait Dixit's avatar
Jait Dixit committed
5

Martin Reinecke's avatar
Martin Reinecke committed
6
**NIFTy** project homepage:
7
[http://ift.pages.mpcdf.de/NIFTy](http://ift.pages.mpcdf.de/NIFTy)
Jait Dixit's avatar
Jait Dixit committed
8
9
10
11
12
13

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
36
37
38
39
point sets, *n*-dimensional regular grids, spherical spaces, their
harmonic counterparts, and product spaces constructed as combinations of
those.


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

### Requirements

Martin Reinecke's avatar
Martin Reinecke committed
40
- [Python](https://www.python.org/) (v2.7.x or 3.5.x)
41
- [SciPy](https://www.scipy.org/)
Martin Reinecke's avatar
Martin Reinecke committed
42
- [pyFFTW](https://pypi.python.org/pypi/pyFFTW)
Martin Reinecke's avatar
Martin Reinecke committed
43
44

Optional dependencies:
Martin Reinecke's avatar
Martin Reinecke committed
45
46
47
48
- [pyHealpix](https://gitlab.mpcdf.mpg.de/ift/pyHealpix) (for harmonic
    transforms involving domains on the sphere)
- [mpi4py](https://mpi4py.scipy.org) (for MPI-parallel execution)
- [matplotlib](https://matplotlib.org/) (for field plotting)
Jait Dixit's avatar
Jait Dixit committed
49

Martin Reinecke's avatar
Martin Reinecke committed
50
### Sources
Jait Dixit's avatar
Jait Dixit committed
51

Philipp Arras's avatar
Philipp Arras committed
52
53
The current version of Nifty5 can be obtained by cloning the repository and
switching to the NIFTy_5 branch:
Jait Dixit's avatar
Jait Dixit committed
54
55
56

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

Martin Reinecke's avatar
Martin Reinecke committed
57
### Installation
Jait Dixit's avatar
Jait Dixit committed
58

Martin Reinecke's avatar
Martin Reinecke committed
59
60
In the following, we assume a Debian-based distribution. For other
distributions, the "apt" lines will need slight changes.
Martin Reinecke's avatar
Martin Reinecke committed
61

Philipp Arras's avatar
Philipp Arras committed
62
NIFTy5 and its mandatory dependencies can be installed via:
Martin Reinecke's avatar
Martin Reinecke committed
63
64

    sudo apt-get install git libfftw3-dev python python-pip python-dev
Martin Reinecke's avatar
Martin Reinecke committed
65
    pip install --user git+https://gitlab.mpcdf.mpg.de/ift/NIFTy.git@NIFTy_5
Martin Reinecke's avatar
Martin Reinecke committed
66

Martin Reinecke's avatar
Martin Reinecke committed
67
68
69
70
71
72
73
74
75
76
(Note: If you encounter problems related to `pyFFTW`, make sure that you are
using a pip-installed `pyFFTW` package. Unfortunately, some distributions are
shipping an incorrectly configured `pyFFTW` package, which does not cooperate
with the installed `FFTW3` libraries.)

Plotting support is added via:

    pip install --user matplotlib

Support for spherical harmonic transforms is added via:
Jait Dixit's avatar
Jait Dixit committed
77

Martin Reinecke's avatar
Martin Reinecke committed
78
    pip install --user git+https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
Jait Dixit's avatar
Jait Dixit committed
79

Martin Reinecke's avatar
Martin Reinecke committed
80
81
82
83
84
85
86
87
88
89
90
91
92
MPI support is added via:

    sudo apt-get install openmpi-bin libopenmpi-dev
    pip install --user mpi4py

### Installation for Python 3

If you want to run NIFTy with Python 3, you need to make the following changes
to the instructions above:

- in all `apt-get` commands, replace `python-*` by `python3-*`
- in all `pip` commands, replace `pip` by `pip3`

Theo Steininger's avatar
Theo Steininger committed
93
94
95
96
### Running the tests

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

Martin Reinecke's avatar
Martin Reinecke committed
97
    pip install --user nose parameterized coverage
98

Martin Reinecke's avatar
Martin Reinecke committed
99
100
Afterwards the tests (including a coverage report) can be run using the
following command in the repository root:
101

Philipp Arras's avatar
Philipp Arras committed
102
    nosetests -x --with-coverage --cover-html --cover-package=nifty5
Theo Steininger's avatar
Theo Steininger committed
103
104


Jait Dixit's avatar
Jait Dixit committed
105
106
### First Steps

Martin Reinecke's avatar
Martin Reinecke committed
107
For a quick start, you can browse through the [informal
108
introduction](http://ift.pages.mpcdf.de/NIFTy/code.html) or
Martin Reinecke's avatar
Martin Reinecke committed
109
dive into NIFTy by running one of the demonstrations, e.g.:
Jait Dixit's avatar
Jait Dixit committed
110

Martin Reinecke's avatar
Martin Reinecke committed
111
    python demos/wiener_filter_via_curvature.py
Jait Dixit's avatar
Jait Dixit committed
112

113
114

### Acknowledgement
Jait Dixit's avatar
Jait Dixit committed
115

Martin Reinecke's avatar
Martin Reinecke committed
116
Please acknowledge the use of NIFTy in your publication(s) by using a
Jait Dixit's avatar
Jait Dixit committed
117
118
phrase such as the following:

Martin Reinecke's avatar
Martin Reinecke committed
119
> "Some of the results in this publication have been derived using the
120
121
> NIFTy package [(https://gitlab.mpcdf.mpg.de/ift/NIFTy)](https://gitlab.mpcdf.mpg.de/ift/NIFTy)"

122
and a citation to one of the [publications](http://ift.pages.mpcdf.de/NIFTy/citations.html).
123
124
125


### Release Notes
Jait Dixit's avatar
Jait Dixit committed
126

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