From 594a3be251935e0d487e0a947693fd02fb664c91 Mon Sep 17 00:00:00 2001
From: Martin Reinecke
Date: Wed, 30 Jan 2019 11:43:26 +0100
Subject: [PATCH] small fixes and rewordings
---
docs/source/code.rst | 6 +++---
docs/source/index.rst | 2 +-
docs/source/installation.rst | 9 ++++-----
3 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/docs/source/code.rst b/docs/source/code.rst
index b906d872..90e17c37 100644
--- a/docs/source/code.rst
+++ b/docs/source/code.rst
@@ -157,8 +157,8 @@ fields with equal domains, or a field and a scalar.
Contractions (like summation, integration, minimum/maximum, computation of
statistical moments) can be carried out either over an entire field (producing
a scalar result) or over sub-domains (resulting in a field defined on a smaller
-domain). Scalar products of two fields can also be computed easily. See the
-documentation of :class:`~field.Field` for details.
+domain). Scalar products of two fields can also be computed easily.
+See the documentation of :class:`~field.Field` for details.
There is also a set of convenience functions to generate fields with constant
values or fields filled with random numbers according to a user-specified
@@ -431,7 +431,7 @@ It needs to be applied in forward direction in order to calculate the Wiener
filter solution, but only its inverse application is straightforward.
To use it in forward direction, we make use of NIFTy's
:class:`~operators.inversion_enabler.InversionEnabler` class, which internally
-does the inverse application of the given operator :math:`x = Op^{-1} (y)` by
+applies the (approximate) inverse of the given operator :math:`x = Op^{-1} (y)` by
solving the equation :math:`y = Op (x)` for :math:`x`.
This is accomplished by minimizing a suitable
:class:`~minimization.quadratic_energy.QuadraticEnergy`
diff --git a/docs/source/index.rst b/docs/source/index.rst
index eb68d5a6..0f72059f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -6,7 +6,7 @@ Its object-oriented framework is written in Python, although it accesses librari
NIFTy offers a toolkit that abstracts discretized representations of continuous spaces, fields in these spaces, and operators acting on these fields into classes.
This allows for an abstract formulation and programming of inference algorithms, including those derived within information field theory.
-The user can develop algorithms on subsets of problems and on spaces where the detailled performance of the algorithm can be properly evaluated and then easily generalize them to other, more complex spaces and the full problem, respectively.
+The user can develop algorithms on subsets of problems and on spaces where the detailed performance of the algorithm can be properly evaluated and then easily generalize them to other, more complex spaces and the full problem, respectively.
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.
NIFTy takes care of numerical subtleties like the normalization of operations on fields and the numerical representation of model components, allowing the user to focus on formulating the abstract inference procedures and process-specific model properties.
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index a822d0d5..1c92ece3 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -14,15 +14,14 @@ Plotting support is added via::
pip3 install --user matplotlib
-Since Jan. 2019 we use Numpy's FFT implementation in order to minimize
-dependencies. However, on some problems like FFTs of non-prime length arrays,
-the library FFTW performs a lot better. If you use NIFTy for large problems
-involving FFTs, you may wish to use the FFTW support. It is added via::
+Since Jan. 2019 NIFTy uses Numpy's FFT implementation by default, in order to
+minimize dependencies. However, for long-running production jobs we still
+recommend using FFTW because of its higher performance. This is achieved via:
sudo apt-get install libfftw3-dev
pip3 install --user pyfftw
-To actually use FFTW in your NIFTy calculations, you need to call::
+To actually enable FFTW in your NIFTy calculations, you need to call::
nifty5.fft.enable_fftw()
--
GitLab