Commit a3e82504 authored by Theo Steininger's avatar Theo Steininger
Browse files

Merge branch 'improve_readme' into 'master'

Improve README.md

See merge request !89
parents 23cbce7a 3dc7b0f5
Pipeline #12482 passed with stages
in 14 minutes and 25 seconds
...@@ -38,25 +38,25 @@ certain grids, **fields** that are defined on spaces, and **operators** ...@@ -38,25 +38,25 @@ certain grids, **fields** that are defined on spaces, and **operators**
that apply to fields. that apply to fields.
- [Spaces](http://www.mpa-garching.mpg.de/ift/nifty/space.html) - [Spaces](http://www.mpa-garching.mpg.de/ift/nifty/space.html)
- `rg_space` - *n*-dimensional regular Euclidean grid - `RGSpace` - *n*-dimensional regular Euclidean grid
- `lm_space` - spherical harmonics - `LMSpace` - spherical harmonics
- `gl_space` - Gauss-Legendre grid on the 2-sphere - `GLSpace` - Gauss-Legendre grid on the 2-sphere
- `hp_space` - [HEALPix](http://sourceforge.net/projects/healpix/) - `HPSpace` - [HEALPix](http://sourceforge.net/projects/healpix/)
grid on the 2-sphere grid on the 2-sphere
- [Fields](http://www.mpa-garching.mpg.de/ift/nifty/field.html) - [Fields](http://www.mpa-garching.mpg.de/ift/nifty/field.html)
- `field` - generic class for (discretized) fields - `Field` - generic class for (discretized) fields
<!-- --> <!-- -->
field.conjugate field.dim field.norm Field.conjugate Field.dim Field.norm
field.dot field.set_val field.weight Field.dot Field.set_val Field.weight
- [Operators](http://www.mpa-garching.mpg.de/ift/nifty/operator.html) - [Operators](http://www.mpa-garching.mpg.de/ift/nifty/operator.html)
- `diagonal_operator` - purely diagonal matrices in a specified - `DiagonalOperator` - purely diagonal matrices in a specified
basis basis
- `projection_operator` - projections onto subsets of a specified - `ProjectionOperator` - projections onto subsets of a specified
basis basis
- `propagator_operator` - information propagator in Wiener filter - `PropagatorOperator` - information propagator in Wiener filter
theory theory
- (and more) - (and more)
- (and more) - (and more)
...@@ -74,12 +74,15 @@ Installation ...@@ -74,12 +74,15 @@ Installation
### Download ### Download
The latest release is tagged **v1.0.7** and is available as a source The current version of Nifty3 can be obtained by cloning the repository:
package at [](https://gitlab.mpcdf.mpg.de/ift/NIFTy/tags). The current
version can be obtained by cloning the repository:
git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git
and switching to the "master" branch:
cd NIFTy
git checkout master
### Installation on Ubuntu ### Installation on Ubuntu
This is for you if you want to install NIFTy on your personal computer This is for you if you want to install NIFTy on your personal computer
...@@ -89,53 +92,31 @@ Starting with a fresh Ubuntu installation move to a folder like ...@@ -89,53 +92,31 @@ Starting with a fresh Ubuntu installation move to a folder like
- Install basic packages like python, python-dev, gsl and others: - Install basic packages like python, python-dev, gsl and others:
sudo apt-get install curl git autoconf sudo apt-get install curl git autoconf python-dev python-pip python-numpy
sudo apt-get install python-dev python-pip gsl-bin libgsl0-dev libfreetype6-dev libpng-dev libatlas-base-dev
- Using pip install numpy etc...:
sudo pip install numpy
- Install pyHealpix: - Install pyHealpix:
git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
cd pyHealpix cd pyHealpix
autoreconf -i && ./configure && make -j4 && sudo make install autoreconf -i && ./configure --prefix=$HOME/.local && make -j4 && make install
cd .. cd ..
- Finally, NIFTy: - Finally, NIFTy:
git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git
cd nifty cd NIFTy
sudo python setup.py install git checkout master
python setup.py install --user
cd .. cd ..
### Installation on a Linux cluster ### Installation on Linux systems in general
This is for you if you want to install NIFTy on a HPC machine or cluster
that is hosted by your university or institute. Most of the dependencies
will most likely already be there, but you won't have superuser
privileges. In this case, instead of:
sudo python setup.py install
use:
python setup.py install --user
or:
python setup.py install --install-lib=/SOMEWHERE Since all the "unconventional" packages (i.e. pyHealpix and NIFTy) listed in the
section above are installed
in the instruction above. This will install the python packages into within the home directory of the user, the installation instructions for these
your local user directory. 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
For pyHealpix, use: "standard" dependencies (python, numpy, etc.) are installed system-wide.
git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
cd pyHealpix
autoreconf -i && ./configure --prefix=$HOME/.local && make -j4 && make install
cd ..
### Installation on OS X 10.11 ### Installation on OS X 10.11
...@@ -157,24 +138,18 @@ may cause trouble. ...@@ -157,24 +138,18 @@ may cause trouble.
autoreconf -i && ./configure --prefix=`python-config --prefix` && make -j4 && sudo make install autoreconf -i && ./configure --prefix=`python-config --prefix` && make -j4 && sudo make install
cd .. cd ..
(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 ...)
- Install NIFTy: - Install NIFTy:
git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git git clone https://gitlab.mpcdf.mpg.de/ift/NIFTy.git
cd nifty cd NIFTy
sudo python setup.py install git checkout master
python setup.py install --user
cd .. cd ..
### Installation using pypi
NIFTY can be installed using [PyPI](https://pypi.python.org/pypi) and
**pip** by running the following command:
pip install ift_nifty
Alternatively, a private or user specific installation can be done by:
pip install --user ift_nifty
### Running the tests ### Running the tests
In oder to run the tests one needs two additional packages: In oder to run the tests one needs two additional packages:
...@@ -222,4 +197,4 @@ The NIFTY package is licensed under the ...@@ -222,4 +197,4 @@ The NIFTY package is licensed under the
[1] Selig et al., "NIFTY - Numerical Information Field Theory - a [1] Selig et al., "NIFTY - Numerical Information Field Theory - a
versatile Python library for signal inference", [A&A, vol. 554, id. versatile Python library for signal inference", [A&A, vol. 554, id.
A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013; A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013;
[arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499) [arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment