prepare release for parSDC paper

Author: pancetta

docs/source/projects/doc_parallelSDC_nonlinear.rst

@@ -9,4 +9,13 @@ Results:
 Results:
 
 .. image:: ../../../data/parallelSDC_fisher.png
-   :scale: 50 %
+   :scale: 50 %
+
+Full code: `projects/parallelSDC/newton_vs_sdc.py <https://github.com/Parallel-in-Time/pySDC/blob/master/projects/parallelSDC/newton_vs_sdc.py>`_
+
+.. literalinclude:: ../../../projects/parallelSDC/newton_vs_sdc.py
+
+Results:
+
+.. image:: ../../../data/parallelSDC_fisher_newton.png
+   :scale: 50 %

projects/parallelSDC/README.rst

@@ -3,6 +3,7 @@ Attempts to parallelize SDC
 
 In this project, we test different strategies to parallelize SDC beyond PFASST.
 More precisely, the goal is to find a robust parallelization strategy *within* each iteration, i.e. parallelization across the collocation nodes.
+This code is used for the publication "Parallelizing SDC across the method".
 
 Different preconditioners for SDC
 ---------------------------------

projects/parallelSDC/data/error_reduction_data.pkl

@@ -110,12 +110,15 @@ def main():
     file.close()
 
 
-def plot_graphs():
+def plot_graphs(cwd=''):
     """
     Helper function to plot graphs of initial and final values
+
+    Args:
+        cwd (str): current working directory
     """
 
-    file = open('data/error_reduction_data.pkl', 'rb')
+    file = open(cwd + 'data/error_reduction_data.pkl', 'rb')
     results = pickle.load(file)
 
     sweeper_list = results['sweeper_list']
@@ -164,15 +167,13 @@ def plot_graphs():
     plt.ylim([4E-03, 1E0])
     plt.xticks(dt_list, dt_list)
 
-    # plt.show()
-
     # save plot as PDF, beautify
     fname = 'data/parallelSDC_fisher_newton.png'
     plt.savefig(fname, rasterized=True, bbox_inches='tight')
 
-    # assert os.path.isfile(fname), 'ERROR: plotting did not create file'
+    assert os.path.isfile(fname), 'ERROR: plotting did not create file'
 
 
 if __name__ == "__main__":
-    # main()
+    main()
     plot_graphs()

projects/parallelSDC/newton_vs_sdc.py

@@ -1,5 +1,9 @@
 from projects.parallelSDC.nonlinear_playground import main, plot_graphs
+from projects.parallelSDC.newton_vs_sdc import plot_graphs as plot_graphs_newton_vs_sdc
 
 def test_main():
     main()
     plot_graphs()
+
+def test_plot_newton_vs_sdc():
+    plot_graphs_newton_vs_sdc(cwd='projects/parallelSDC/')