Readme for project

Author: pancetta

docs/source/index.rst

@@ -95,6 +95,7 @@ Projects
    projects/RDC.rst
    projects/asymp_conv.rst
    projects/matrixPFASST.rst
+   projects/SDC_showdown.rst
 
 
 Tests

docs/source/projects/SDC_showdown.rst

@@ -0,0 +1 @@
+.. include:: /../../pySDC/projects/SDC_showdown/README.rst

docs/source/projects/doc_SDC_showdown.rst

@@ -0,0 +1,18 @@
+Full code: `pySDC/projects/SDC_showdown/SDC_timing_Fisher.py <https://github.com/Parallel-in-Time/pySDC/blob/master/pySDC/projects/SDC_showdown/SDC_timing_Fisher.py>`_
+
+.. literalinclude:: ../../../pySDC/projects/SDC_showdown/SDC_timing_Fisher.py
+
+Results:
+
+.. image:: ../../../data/timings_SDC_variants_Fisher.png
+   :scale: 100 %
+
+
+Full code: `pySDC/projects/SDC_showdown/SDC_timing_GrayScott.py <https://github.com/Parallel-in-Time/pySDC/blob/master/pySDC/projects/SDC_showdown/SDC_timing_GrayScott.py>`_
+
+.. literalinclude:: ../../../pySDC/projects/SDC_showdown/SDC_timing_GrayScott.py
+
+Results:
+
+.. image:: ../../../data/timings_SDC_variants_GrayScott.png
+   :scale: 100 %

pySDC/projects/SDC_showdown/README.rst

@@ -0,0 +1,16 @@
+What is the fastest SDC variant?
+================================
+
+In this project, we test different variants of SDC for a particular problem to see which one is the fastest.
+More precisely, we run SDC for the 1D Fisher equation and the 2D Gray-Scott problem with PETSc data types and solvers, using fully implicit, semi-implicit and multi-implicit time-stepping.
+We also test exact spatial solves vs. inexact ones (aka inexact SDC, ISDC)
+
+Fisher and Gray-Scott equations
+-------------------------------
+
+The two run scripts simply test all variants of SDC after the other, each of them exact and then inexact.
+The results are gathered, stored and shown in comparison.
+Note that on standard machines the inexact semi-implicit variant wins each time (may be different for the CI testing).
+
+.. include:: doc_SDC_showdown.rst
+