installation.rst 1.18 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.

Philipp Arras's avatar
Philipp Arras committed
8
NIFTy5 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_5
Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
12
    pip3 install --user git+https://gitlab.mpcdf.mpg.de/mtr/pypocketfft
Martin Reinecke's avatar
Martin Reinecke committed
13

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

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

Martin Reinecke's avatar
Martin Reinecke committed
18
Support for spherical harmonic transforms is added via::
Martin Reinecke's avatar
Martin Reinecke committed
19

Martin Reinecke's avatar
Martin Reinecke committed
20
    pip3 install --user git+https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
Martin Reinecke's avatar
Martin Reinecke committed
21

Martin Reinecke's avatar
Martin Reinecke committed
22 23 24 25
Support for the radio interferometry gridder is added via:

    pip3 install git+https://gitlab.mpcdf.mpg.de/ift/nifty_gridder.git

Martin Reinecke's avatar
Martin Reinecke committed
26 27
MPI support is added via::

Martin Reinecke's avatar
Martin Reinecke committed
28
    sudo apt-get install python3-mpi4py
29 30 31 32 33 34 35 36 37 38 39 40

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
41
imports nifty from the Python path.)
42