Skip to content

Commit 06c38a2

Browse files
committed
Update the front page
1 parent 05bee2f commit 06c38a2

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

docs/source/index.rst

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,59 @@
22
sphinx-quickstart on Wed Feb 15 14:31:32 2023.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
5-
6-
Welcome to the documentation for the 2decomp&fft library!
5+
=========================================================
6+
Welcome to the documentation for the 2DECOMP&FFT library!
77
=========================================================
88

9-
.. note::
10-
This website is still **under development**!
11-
12-
The 2DECOMP&FFT library is a software framework written in modern Fortran to build large-scale parallel applications. It is designed for applications using three-dimensional structured mesh and spatially implicit numerical algorithms. At the foundation it implements a general-purpose 2D pencil decomposition for data distribution. On top it provides a highly scalable and efficient interface to perform three-dimensional distributed Fast Fourier Transforms. The library was originaly designed for CPUs only in the 2010's. The new version has be designed to work on CPUs and (NVIDIA) GPUs. We will aim to expend the capabilities of the library in the future (and to fix bugs!).
9+
The 2DECOMP&FFT library is a software framework written in modern Fortran to build large-scale parallel applications.
10+
It is designed for applications using three-dimensional structured mesh and spatially implicit numerical algorithms.
11+
At the foundation it implements a general-purpose 2D pencil decomposition for data distribution.
12+
On top it provides a highly scalable and efficient interface to perform three-dimensional distributed Fast Fourier Transforms.
13+
The library was originaly designed for CPUs only in the 2010's.
14+
The new version has be designed to work on CPUs and (NVIDIA) GPUs. We will aim to expend the capabilities of the library in the future (and to fix bugs!).
1315

14-
**Features**
15-
=============
16+
Features
17+
========
1618

1719
Here is a list of 2DECOMP&FFT's main features:
1820

19-
-General-purpose 2D pencil decomposition module to support building large-scale parallel applications on supercomputers.
21+
* General-purpose 2D pencil decomposition module to support building large-scale parallel applications on supercomputers.
2022

21-
-Highly scalable and efficient distributed Fast Fourier Transform module, supporting three dimensional FFTs (both complex-to-complex and real-to-complex/complex-to-real).
23+
* Highly scalable and efficient distributed Fast Fourier Transform module,
24+
supporting three dimensional FFTs (both complex-to-complex and real-to-complex/complex-to-real).
2225

23-
-Halo-cell support allowing explicit message passing between neighbouring blocks.
26+
* Halo-cell support allowing explicit message passing between neighbouring blocks.
2427

25-
-Parallel I/O module to support the handling of large data sets.
28+
* Parallel I/O module to support the handling of large data sets.
2629

27-
-Interface with most popular external FFT libraries.
30+
* Interface with most popular external FFT libraries.
2831

2932
**2DECOMP&FFT is designed to be:**
3033

31-
**Scalable** - The library and applications built upon it are known to scale well on thousands of CPU cores.
34+
* **Scalable** - The library and applications built upon it are known
35+
to scale well on thousands of CPU cores.
3236

33-
**Flexible** - Software framework to support building higher-level libraries and many types of applications.
37+
* **Flexible** - Software framework to support building higher-level
38+
libraries and many types of applications.
3439

35-
**User-friendly** - Black-box implementation and very clean application programming interface hiding most communication details from applications.
40+
* **User-friendly** - Black-box implementation and very clean application programming
41+
interface hiding most communication details from applications.
3642

37-
**Portable** - Code tested on major hardware architectures, with different compilers.
43+
* **Portable** - Code tested on major hardware architectures, with different compilers.
3844

39-
**Publication**
40-
===============
45+
Publication
46+
===========
4147

4248
N. Li and S. Laizet, "2DECOMP&FFT – A highly scalable 2D decomposition library and FFT interface", Cray User Group 2010 conference, Edinburgh, 2010
4349

4450
**a new paper is in preparation to introduce the new capabilities of the library**
4551

4652
**Acknowledgements**
4753
====================
48-
The library was initially designed thanks to several projects funded under the HECToR Distributed Computational Science and Engineering (CSE) Service operated by NAG Ltd. The new library has been designed thanks to the support of EPSRC via the `CCP Turbulence <https://www.ukturbulence.co.uk/ccp-turbulence.html>`_ (EP/T026170/1).
54+
The library was initially designed thanks to several projects funded under the
55+
HECToR Distributed Computational Science and Engineering (CSE) Service operated by NAG Ltd.
56+
The new library has been designed thanks to the support of EPSRC via the
57+
`CCP Turbulence <https://www.ukturbulence.co.uk/ccp-turbulence.html>`_ (EP/T026170/1).
4958

5059
.. toctree::
5160
:maxdepth: 2

0 commit comments

Comments
 (0)