working on the website

Author: slaizet

docs/source/conf.py

@@ -28,6 +28,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+   'sphinx.ext.graphviz',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -49,4 +50,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']

docs/source/index.rst

@@ -57,3 +57,4 @@ The library was initially designed thanks to several projects funded under the H
    pages/api.rst
    pages/benchmarks.rst
    pages/publications.rst
+   pages/contributing.rst

docs/source/pages/contributing.rst

@@ -0,0 +1,45 @@
+=============
+Contributing
+=============
+
+Overview of the contribution process
+====================================
+
+The graph below illustrates the general process for contributing code
+changes to 2decomp&fft:
+
+.. graphviz::
+
+   digraph G {
+       review[shape="diamond", label="Changes approved"]
+       commit[label="commit changes locally"]
+
+       PR[label="Open/update Pull Request"];
+
+       Idea -> "Open new issue" -> commit -> PR
+       PR -> review
+       review -> merge [label="yes"]
+       review -> commit [label=" no"]
+       "Pick existing issue" -> commit
+
+       {
+           rank=sink;
+           review; merge
+       }
+   }
+
+Contributions are accepeted in the form of pull requests targeting the
+`main` branch on the 2decomp&fft GitHub repository.  See `(GitHub docs)
+Creating a pull request
+<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_.
+
+By default your GitHub account will not be able to push changes to the
+2decomp&fft repo, and you will have to open the pull request from a fork. See
+`(GitHub docs) Creating a pull request from a fork
+<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`_.
+
+Note that the whole process is **driven by issues**. If you found a
+bug not currently referenced by an existing issue, or have an idea on
+how to improve a part of 2decomp&fft, please open a new item on the issue
+tracker before opening a pull request.
+

docs/source/pages/fft.rst

@@ -0,0 +1,11 @@
+=========================
+Fast Fourier Transforms
+=========================
+
+The Discrete Fourier Transform (DFT) plays an important role in many scientific and technical applications, including time-series and waveform analysis, solutions to linear partial
+differential equations, convolution, digital signal processing, and image filtering. Many algorithms have been proposed to compute DFTs with a good efficiency and the most famous clas of efficient algorithms is generally referred to as fast Fourier transform (FFT) algorithms.
+
+
+The 2Decomp&FFT is providing an API to perform FFTs at scale using a 2D Domain Decomposition on CPUs and on GPUs. There are hundreds of FFT software packages available but only few of them suitable for multi-GPUs. 
+
+ 

readme.md

@@ -0,0 +1 @@
+test