README.rst 5.84 KB
Newer Older
Marco Selig's avatar
Marco Selig committed
1 2
NIFTY - Numerical Information Field Theory
==========================================
Marco Selig's avatar
Marco Selig committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

**NIFTY** project homepage: `<http://www.mpa-garching.mpg.de/ift/nifty/>`_

Summary
-------

Description
...........

**NIFTY**, "\ **N**\umerical **I**\nformation **F**\ield **T**\heor\ **y**\ ",
is 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 Python, although it
accesses libraries written in Cython, C++, and C for 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.

Marco Selig's avatar
Marco Selig committed
37
*   `Spaces <http://www.mpa-garching.mpg.de/ift/nifty/space.html>`_
Marco Selig's avatar
Marco Selig committed
38

Marco Selig's avatar
Marco Selig committed
39 40 41 42 43
    *   ``point_space`` - unstructured list of points
    *   ``rg_space`` - *n*-dimensional regular Euclidean grid
    *   ``lm_space`` - spherical harmonics
    *   ``gl_space`` - Gauss-Legendre grid on the 2-sphere
    *   ``hp_space`` - `HEALPix <http://sourceforge.net/projects/healpix/>`_
Marco Selig's avatar
Marco Selig committed
44
        grid on the 2-sphere
Marco Selig's avatar
Marco Selig committed
45
    *   ``nested_space`` - arbitrary product of grids
Marco Selig's avatar
Marco Selig committed
46

Marco Selig's avatar
Marco Selig committed
47
*   `Fields <http://www.mpa-garching.mpg.de/ift/nifty/field.html>`_
Marco Selig's avatar
Marco Selig committed
48

Marco Selig's avatar
Marco Selig committed
49 50 51
    *   ``field`` - generic class for (discretized) fields

::
Marco Selig's avatar
Marco Selig committed
52 53 54 55 56 57

    field.cast_domain   field.hat           field.power        field.smooth
    field.conjugate     field.inverse_hat   field.pseudo_dot   field.tensor_dot
    field.dim           field.norm          field.set_target   field.transform
    field.dot           field.plot          field.set_val      field.weight

Marco Selig's avatar
Marco Selig committed
58
*   `Operators <http://www.mpa-garching.mpg.de/ift/nifty/operator.html>`_
Marco Selig's avatar
Marco Selig committed
59

Marco Selig's avatar
Marco Selig committed
60 61 62
    *   ``diagonal_operator`` - purely diagonal matrices in a specified basis
    *   ``projection_operator`` - projections onto subsets of a specified basis
    *   ``vecvec_operator`` - matrices derived from the outer product of a
Marco Selig's avatar
Marco Selig committed
63
        vector
Marco Selig's avatar
Marco Selig committed
64
    *   ``response_operator`` - exemplary responses that include a convolution,
Marco Selig's avatar
Marco Selig committed
65
        masking and projection
Marco Selig's avatar
Marco Selig committed
66
    *   ``propagator_operator`` - information propagator in Wiener filter theory
Marco Selig's avatar
Marco Selig committed
67 68
    *   ``explicit_operator`` - linear operators with an explicit matrix
        representation
Marco Selig's avatar
Marco Selig committed
69
    *   (and more)
Marco Selig's avatar
Marco Selig committed
70

Marco Selig's avatar
Marco Selig committed
71
* (and more)
Marco Selig's avatar
Marco Selig committed
72

Marco Selig's avatar
Marco Selig committed
73
*Parts of this summary are taken from* [1]_ *without marking them explicitly as
Marco Selig's avatar
Marco Selig committed
74
quotations.*
Marco Selig's avatar
Marco Selig committed
75 76 77 78 79 80 81

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

Requirements
............

Marco Selig's avatar
Marco Selig committed
82
*   `Python <http://www.python.org/>`_ (v2.7.x)
Marco Selig's avatar
Marco Selig committed
83

Marco Selig's avatar
Marco Selig committed
84 85 86
    *   `NumPy <http://www.numpy.org/>`_ and `SciPy <http://www.scipy.org/>`_
    *   `matplotlib <http://matplotlib.org/>`_
    *   `multiprocessing <http://docs.python.org/2/library/multiprocessing.html>`_
Marco Selig's avatar
Marco Selig committed
87 88
        (standard library)

Marco Selig's avatar
Marco Selig committed
89
*   `GFFT <https://github.com/mrbell/gfft>`_ (v0.1.0) - Generalized Fast
Marco Selig's avatar
Marco Selig committed
90
    Fourier Transformations for Python - **optional**
Marco Selig's avatar
Marco Selig committed
91

Marco Selig's avatar
Marco Selig committed
92
*   `HEALPy <https://github.com/healpy/healpy>`_ (v1.4 without openmp) - A
Marco Selig's avatar
Marco Selig committed
93
    Python wrapper for `HEALPix <http://sourceforge.net/projects/healpix/>`_ -
Marco Selig's avatar
Marco Selig committed
94
    **optional**
Marco Selig's avatar
Marco Selig committed
95

Marco Selig's avatar
Marco Selig committed
96
*   `libsharp-wrapper <https://github.com/mselig/libsharp-wrapper>`_ (v0.1.2
Marco Selig's avatar
Marco Selig committed
97
    without openmp) - A Python wrapper for the
Marco Selig's avatar
Marco Selig committed
98 99
    `libsharp <http://sourceforge.net/projects/libsharp/>`_ library -
    **optional**
Marco Selig's avatar
Marco Selig committed
100 101 102 103

Download
........

Marco Selig's avatar
Marco Selig committed
104
The latest release is tagged **v1.0.6** and is available as a source package
Marco Selig's avatar
Marco Selig committed
105 106
at `<https://github.com/information-field-theory/nifty/tags>`_. The current
version can be obtained by cloning the repository::
Marco Selig's avatar
Marco Selig committed
107

Marco Selig's avatar
Marco Selig committed
108
    git clone git://github.com/information-field-theory/nifty.git
Marco Selig's avatar
Marco Selig committed
109 110 111 112 113
    cd nifty

Installation
............

Marco Selig's avatar
Marco Selig committed
114 115
*   NIFTY can be installed using `PyPI <https://pypi.python.org/pypi>`_ and
    **pip** by running the following command::
Marco Selig's avatar
Marco Selig committed
116

Marco Selig's avatar
Marco Selig committed
117
        pip install ift_nifty
Marco Selig's avatar
Marco Selig committed
118

Marco Selig's avatar
Marco Selig committed
119
    Alternatively, a private or user specific installation can be done by::
Marco Selig's avatar
Marco Selig committed
120

Marco Selig's avatar
Marco Selig committed
121
        pip install --user ift_nifty
Marco Selig's avatar
Marco Selig committed
122 123


Marco Selig's avatar
Marco Selig committed
124 125
*   NIFTY can be installed using **Distutils** by running the following
    command::
Marco Selig's avatar
Marco Selig committed
126

Marco Selig's avatar
Marco Selig committed
127
        python setup.py install
Marco Selig's avatar
Marco Selig committed
128

Marco Selig's avatar
Marco Selig committed
129
    Alternatively, a private or user specific installation can be done by::
Marco Selig's avatar
Marco Selig committed
130

Marco Selig's avatar
Marco Selig committed
131 132
        python setup.py install --user
        python setup.py install --install-lib=/SOMEWHERE
Marco Selig's avatar
Marco Selig committed
133

Marco Selig's avatar
Marco Selig committed
134 135 136 137 138 139 140 141 142
First Steps
...........

For a quickstart, you can browse through the
`informal introduction <http://www.mpa-garching.mpg.de/ift/nifty/start.html>`_
or dive in to NIFTY by running one of the demos, e.g.::

        >>> run -m nifty.demos.demo_wf1

Marco Selig's avatar
Marco Selig committed
143 144 145 146 147 148
Acknowledgement
---------------

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

Marco Selig's avatar
Marco Selig committed
149
    *"Some of the results in this publication have been derived using the NIFTY
Marco Selig's avatar
Marco Selig committed
150
    package [Selig et al., 2013]."*
Marco Selig's avatar
Marco Selig committed
151 152 153 154

References
..........

Marco Selig's avatar
Marco Selig committed
155
.. [1] Selig et al., "NIFTY - Numerical Information Field Theory - a
Marco Selig's avatar
Marco Selig committed
156 157 158
    versatile Python library for signal inference",
    `A&A, vol. 554, id. A26 <http://dx.doi.org/10.1051/0004-6361/201321236>`_,
    2013; `arXiv:1301.4499 <http://www.arxiv.org/abs/1301.4499>`_
Marco Selig's avatar
Marco Selig committed
159 160 161 162 163 164 165 166

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

The NIFTY package is licensed under the
`GPLv3 <http://www.gnu.org/licenses/gpl.html>`_ and is distributed *without any
warranty*.

Marco Selig's avatar
Marco Selig committed
167 168
----

Marco Selig's avatar
Marco Selig committed
169 170
**NIFTY** project homepage: `<http://www.mpa-garching.mpg.de/ift/nifty/>`_