Commit 3755c48d authored by Martin Reinecke's avatar Martin Reinecke

Merge branch 'adjust_readme' into 'NIFTy_5'

Adjust readme

See merge request ift/nifty-dev!219
parents 33a76ea6 3d031f11
NIFTy - Numerical Information Field Theory NIFTy - Numerical Information Field Theory
========================================== ==========================================
[![build status](https://gitlab.mpcdf.mpg.de/ift/nifty-dev/badges/NIFTy_5/build.svg)](https://gitlab.mpcdf.mpg.de/ift/nifty-dev/commits/NIFTy_5) [![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-dev/badges/NIFTy_5/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/nifty-dev/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)
**NIFTy** project homepage: **NIFTy** project homepage:
[http://ift.pages.mpcdf.de/NIFTy](http://ift.pages.mpcdf.de/NIFTy) [http://ift.pages.mpcdf.de/NIFTy](http://ift.pages.mpcdf.de/NIFTy)
...@@ -66,14 +66,15 @@ NIFTy5 and its mandatory dependencies can be installed via: ...@@ -66,14 +66,15 @@ NIFTy5 and its mandatory dependencies can be installed via:
Plotting support is added via: Plotting support is added via:
pip3 install --user matplotlib sudo apt-get install python3-matplotlib
FFTW support is added via: NIFTy uses Numpy's FFT implementation by default. For large problems FFTW may be
used because of its higher performance. It can be installed via:
sudo apt-get install libfftw3-dev sudo apt-get install libfftw3-dev
pip3 install --user pyfftw pip3 install --user pyfftw
To actually use FFTW in your Nifty calculations, you need to call To enable FFTW usage in NIFTy, call
nifty5.fft.enable_fftw() nifty5.fft.enable_fftw()
...@@ -90,14 +91,13 @@ Support for spherical harmonic transforms is added via: ...@@ -90,14 +91,13 @@ Support for spherical harmonic transforms is added via:
MPI support is added via: MPI support is added via:
sudo apt-get install openmpi-bin libopenmpi-dev sudo apt-get install python3-mpi4py
pip3 install --user mpi4py
### Running the tests ### Running the tests
To run the tests, additional packages are required: To run the tests, additional packages are required:
sudo apt-get install python3-coverage python3-pytest python3-pytest-cov sudo apt-get install python3-pytest-cov
Afterwards the tests (including a coverage report) can be run using the Afterwards the tests (including a coverage report) can be run using the
following command in the repository root: following command in the repository root:
......
...@@ -12,7 +12,7 @@ NIFTy5 and its mandatory dependencies can be installed via:: ...@@ -12,7 +12,7 @@ NIFTy5 and its mandatory dependencies can be installed via::
Plotting support is added via:: Plotting support is added via::
pip3 install --user matplotlib sudo apt-get install python3-matplotlib
NIFTy uses Numpy's FFT implementation by default. For large problems FFTW may be NIFTy uses Numpy's FFT implementation by default. For large problems FFTW may be
used because of its higher performance. It can be installed via:: used because of its higher performance. It can be installed via::
...@@ -37,5 +37,4 @@ Support for spherical harmonic transforms is added via:: ...@@ -37,5 +37,4 @@ Support for spherical harmonic transforms is added via::
MPI support is added via:: MPI support is added via::
sudo apt-get install openmpi-bin libopenmpi-dev sudo apt-get install python3-mpi4py
pip3 install --user mpi4py
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