docu: extending/fixing/cleaning docu for upcoming release

Author: torbjoernk

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog                                                                        {#page_changelog}
 
-## v0.2.0 -- MPI PFASST (2014/XX/XX)
+## v0.2.0 -- MPI PFASST (2014/08/XX)
 
 XXX: DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)
 
@@ -10,21 +10,38 @@ XXX: DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)
 
 ### Details
 
-* Addition of MPI based PFASST algorithm using the standard predictor
-  stage in a block mode with fixed iterations.
+* Addition of MPI based PFASST algorithm using the standard predictor stage in a block mode with 
+  fixed iterations.
   ([#46][], [#57][], [#59][])
 
 * Addition of a simple scalar example and appropriate tests.
-  ([#61][], [#76][])
+  ([#61][], [#63][], [#76][])
+
+* Further tests on proper calculation of quadrature nodes and weights
+  ([#74][])
+
+* Better handling of 3rd-party dependencies
+  ([#53][], [#55][])
 
 * Various tidying
-  ()
+  ([#56][], [#60][], [#77][])
+
+* Basic Profiling support and test coverage report
+  ([#78][])
 
 [#46]: https://github.com/Parallel-in-Time/PFASST/pull/46
 [#57]: https://github.com/Parallel-in-Time/PFASST/pull/56
 [#59]: https://github.com/Parallel-in-Time/PFASST/pull/59
+[#53]: https://github.com/Parallel-in-Time/PFASST/pull/53
+[#55]: https://github.com/Parallel-in-Time/PFASST/pull/55
+[#56]: https://github.com/Parallel-in-Time/PFASST/pull/56
+[#60]: https://github.com/Parallel-in-Time/PFASST/pull/60
 [#61]: https://github.com/Parallel-in-Time/PFASST/pull/61
+[#63]: https://github.com/Parallel-in-Time/PFASST/pull/63
+[#74]: https://github.com/Parallel-in-Time/PFASST/pull/74
 [#76]: https://github.com/Parallel-in-Time/PFASST/pull/76
+[#77]: https://github.com/Parallel-in-Time/PFASST/pull/77
+[#78]: https://github.com/Parallel-in-Time/PFASST/pull/78
 
 ### Contributors
 
@@ -38,6 +55,7 @@ XXX: DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)
 [danielru]: https://github.com/danielru
 [pancetta]: https://github.com/pancetta
 
+
 ## v0.1.0 -- First Release (2014/07/25)
 
 DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)

README.md

@@ -30,6 +30,7 @@ Currently, it features the following content:
 * \subpage #page_examples
 * \subpage #page_contributing
 * \subpage #page_style_guide
+* \subpage #page_troubleshooting
 
 
 Releases
@@ -58,8 +59,11 @@ Build status
 
 For details see [Travis][pfasst-travis].
 
+A test coverage report is generated and published by [Jenkins][coverage-report].
 
-[documentation]: https://pint.fz-juelich.de/ci/view/PFASST/job/PFASST%20%28Docu%29/doxygen/
-[pfasst-travis]: https://travis-ci.org/Parallel-in-Time/PFASST
-[master-status]: https://travis-ci.org/Parallel-in-Time/PFASST.svg?branch=master
-[dev-status]:    https://travis-ci.org/Parallel-in-Time/PFASST.svg?branch=development
+
+[documentation]:   https://pint.fz-juelich.de/ci/view/PFASST/job/PFASST%20%28Docu%29/doxygen/
+[pfasst-travis]:   https://travis-ci.org/Parallel-in-Time/PFASST
+[master-status]:   https://travis-ci.org/Parallel-in-Time/PFASST.svg?branch=master
+[dev-status]:      https://travis-ci.org/Parallel-in-Time/PFASST.svg?branch=development
+[coverage-report]: https://pint.fz-juelich.de/ci/job/PFASST_GCC_4-8_Coverage/Test_Coverage

doc/source/examples.md

@@ -3,3 +3,8 @@
 ## Simple Advection Diffusion
 
 See \subpage page_examples_advection_diffusion.
+
+
+## Scalar
+
+See \subpage page_examples_scalar.

doc/source/installing.md

@@ -20,35 +20,37 @@ Just use _Git_ to clone the repository.
 
    * By default everything gets built, i.e. tests and examples.
 
-   * To deactivate the tests, pass `-Dpfasst_BUILD_TESTS=OFF` to the
-     _CMake_ command line.
+   * To deactivate the tests, pass `-Dpfasst_BUILD_TESTS=OFF` to the _CMake_ command line.
 
-   * To deactivate the examples, pass `-Dpfasst_BUILD_EXAMPLES=OFF` to
-     the _CMake_ command line.
+   * To deactivate the examples, pass `-Dpfasst_BUILD_EXAMPLES=OFF` to the _CMake_ command line.
 
-   * If you are not on a _Darvin_ system (i.e. MacOS, OSX, ...) and
-     you are using _Clang_ as the compiler, you want to deactivate the
-     use of LLVM's libc++ by passing `-Dpfasst_DISABLE_LIBCXX=ON` to
-     the _CMake_ command line.
+   * To enable profiling support, you need to specify `-Dpfasst_WITH_GCC_PROF` and have the GNU 
+     compiler selected.
 
-   * For example, to build with _Clang_ on a Linux system without the
-     examples, the call to _CMake_ looks like:
+   * If you are not on a _Darvin_ system (i.e. MacOS, OSX, ...) and you are using _Clang_ as the 
+     compiler, you want to deactivate the use of LLVM's libc++ by passing 
+     `-Dpfasst_DISABLE_LIBCXX=ON` to the _CMake_ command line. (this is the default)
 
-       cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -Dpfasst_DISABLE_LIBCXX=ON -Dpfasst_BUILD_EXAMPLES=OFF ..
+   * For example, to build with _Clang_ on a Linux system without the examples, the call to 
+     _CMake_ looks like:
 
-   The [Google Testing] and [Mocking Framework] are required for the
-   unit tests, and are automatically downloaded and built.
+       cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ [-Dpfasst_DISABLE_LIBCXX=ON] -Dpfasst_BUILD_EXAMPLES=OFF ..
 
-   The [FFTW3] library is required for (some) of the examples, and it
-   automatically downloaded and built as well.
+   The [Google Testing] and [Mocking Framework] are required for the unit tests, and are 
+   automatically downloaded and built.
+
+   The [FFTW3] library is required for (some) of the examples. It will be automatically downloaded 
+   and built as well if it is not found on the system.
 
 3. Run the unit tests (if unit tests have been built):
 
        make test
 
 4. Run the examples (if they have been built):
 
-       ./examples/advection
+       make run_example_all
+
+   Or go to `./dist/examples` and look for the exetuable you want to run.
 
 [Google Testing]: https://code.google.com/p/googletest/
 [Mocking Framework]: https://code.google.com/p/googlemock/

doc/source/troubleshooting.md

@@ -1,4 +1,4 @@
-# Trouble shooting                                                                  {#page_trouble}
+# Trouble Shooting                                                           {#page_troubleshooting}
 
 ## I'm getting SEGFAULTs, how do I track them down?
 

examples/scalar/README.md

@@ -0,0 +1,7 @@
+# Scalar                                                                     {#page_examples_scalar}
+
+This directory contains a simple implementations of scalar ODE solver using the PFASST framework.
+
+The SDC sweeper is defined in `scalar_sweeper.hpp`.
+As this simple equation does not require any special handling, all the SDC magic is derived and 
+taken from pfasst::encap::IMEXSweeper::sweep().