Skip to content

Commit bba9fcc

Browse files
committed
Work on paper.md
1 parent 0327963 commit bba9fcc

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

docs/paper/paper.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ discrete Fourier transform. The FFT is one of the most important algorithms
2828
utilized throughout science and society and it has been named *the most
2929
important numerical algorith of our time* by Prof Gilbert Strang [@strang].
3030

31-
``Mpi4py-fft`` (https://bitbucket.org/mpi4py/mpi4py-fft) is an open-source
31+
``mpi4py-fft`` (https://bitbucket.org/mpi4py/mpi4py-fft) is an open-source
3232
Python package for computing (in parallel) FFTs of possibly very large and
3333
distributed multidimensional arrays.
34-
A multidimensional FFT is computed sequentially over all axes, one axis at the time.
34+
A multidimensional FFT is computed sequentially, over all axes, one axis at the time.
3535
A problem with parallel FFTs is that, to fit in the memory of multiple processors,
3636
multidimensional arrays will be distributed along some, but not all, of its axes.
3737
Consequently, parallel FFTs are computed as sequential (serial) transforms over
@@ -49,18 +49,23 @@ under the hood by MPI for Python. For serial transforms
4949
from Python. We include wrappers for complex-to-complex, real-to-complex,
5050
complex-to-real and real-to-real transforms.
5151

52-
``Mpi4py-fft`` is highly configurable in how it distributes and redistributes
52+
``mpi4py-fft`` is highly configurable in how it distributes and redistributes
5353
arrays. Large arrays may be globally redistributed for alignement
5454
along any given axis, whenever needed by the user. This
5555
flexibility has enabled the development of ``shenfun``
5656
[@mortensen_joss,@mortensen17], which is a computing platform
5757
for solving partial differential equations (PDEs) by the spectral Galerkin method.
5858
In ``shenfun`` it is possible to solve PDEs of any given dimensionality, by creating
5959
tensor product bases as outer products of one-dimensional bases. This leads to
60-
large multidimensional arrays that are distributed effortlessly using ``mpi4py-fft``.
60+
large multidimensional arrays that are distributed effortlessly through ``mpi4py-fft``.
6161

62-
``Mpi4py-fft`` can be utilized by anyone that needs to perform FFTs on large
63-
multidimensional arrays. It is installable from ``pypi`` and conda-forge, and
62+
``mpi4py-fft`` can be utilized by anyone that needs to perform FFTs on large
63+
multidimensional arrays. Through its distributed array interface it can also be
64+
utilized by any application relying on algorithms (not just FFTs) with varying
65+
degrees of locality on multidimensional arrays, where MPI can be used to boost
66+
performance.
67+
68+
``mpi4py-fft`` is installable from ``pypi`` and ``conda-forge``, and
6469
released under a permissive 2-clause BSD-license, in the hope that it will be
6570
useful.
6671

mpi4py_fft/distarray.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ class DistArray(np.ndarray):
1818
Shape of non-distributed global array
1919
subcomm : None, Subcomm instance or sequence of ints, optional
2020
Describes how to distribute the array
21-
val : int or None, optional
22-
Initialize array with this int if buffer is not given
21+
val : Number or None, optional
22+
Initialize array with this number if buffer is not given
2323
dtype : np.dtype, optional
2424
Type of array
2525
buffer : np.ndarray, optional

0 commit comments

Comments
 (0)