installation.rst 1.31 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
Installation
============


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

Martin Reinecke's avatar
Martin Reinecke committed
8
NIFTy7 and its mandatory dependencies can be installed via::
Martin Reinecke's avatar
Martin Reinecke committed
9

Martin Reinecke's avatar
fixes  
Martin Reinecke committed
10
    sudo apt-get install git python3 python3-pip python3-dev
Martin Reinecke's avatar
Martin Reinecke committed
11
    pip3 install --user git+https://gitlab.mpcdf.mpg.de/ift/nifty.git@NIFTy_7
Martin Reinecke's avatar
Martin Reinecke committed
12

Martin Reinecke's avatar
fixes  
Martin Reinecke committed
13
14
Plotting support is added via::

Martin Reinecke's avatar
Martin Reinecke committed
15
    sudo apt-get install python3-matplotlib
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
16

17
The DUCC0 package is installed via::
Martin Reinecke's avatar
Martin Reinecke committed
18

19
    pip3 install --user ducc0
Martin Reinecke's avatar
switch  
Martin Reinecke committed
20
21

If this library is present, NIFTy will detect it automatically and prefer
22
`ducc0.fft` over SciPy's FFT. The underlying code is actually the same, but
Martin Reinecke's avatar
switch  
Martin Reinecke committed
23
24
DUCC's FFT is compiled with optimizations for the host CPU and can provide
significantly faster transforms.
Martin Reinecke's avatar
Martin Reinecke committed
25

Philipp Arras's avatar
Philipp Arras committed
26
Support for the radio interferometry gridder is added via::
Martin Reinecke's avatar
Martin Reinecke committed
27

Martin Reinecke's avatar
Martin Reinecke committed
28
    pip3 install --user git+https://gitlab.mpcdf.mpg.de/ift/nifty_gridder.git
Martin Reinecke's avatar
Martin Reinecke committed
29

Martin Reinecke's avatar
Martin Reinecke committed
30
31
MPI support is added via::

Martin Reinecke's avatar
Martin Reinecke committed
32
    sudo apt-get install python3-mpi4py
33
34
35
36
37
38
39
40
41
42
43
44

NIFTy documentation is provided by Sphinx. To build the documentation::

    sudo apt-get install python3-sphinx-rtd-theme dvipng
    cd <nifty_directory>
    sh docs/generate.sh

To view the documentation in firefox::

    firefox docs/build/index.html

(Note: Make sure that you reinstall nifty after each change since sphinx
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
45
imports nifty from the Python path.)
46