documentation

Author: pancetta

.travis.yml

@@ -36,7 +36,7 @@ script:
   - mkdir data
   - which nosetests
   - nosetests tests -v --with-id --with-coverage --cover-package=pySDC,tutorial --cover-inclusive --cover-html --cover-html-dir=target/doc/build/test_coverage
-  - travis-sphinx --branches=pySDC_v2,master build
+  - travis-sphinx build
 
 after_success:
     - travis-sphinx deploy

docs/source/index.rst

@@ -1,17 +1,49 @@
-.. pySDC documentation master file, created by
-   sphinx-quickstart on Tue Oct 11 15:58:40 2016.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to pySDC's documentation!
 =================================
 
-The pySDC project is a Python implementation of the spectral deferred correction (SDC) approach and its flavors,
-esp. the multilevel extension MLSDC and PFASST.
-It is intended for rapid prototyping and educational purposes.
+The `pySDC` project is a Python implementation of the spectral deferred correction (SDC) approach and its flavors,
+esp. the multilevel extension MLSDC and PFASST. It is intended for rapid prototyping and educational purposes.
 New ideas like e.g. sweepers or predictors can be tested and first toy problems can be easily implemented.
 
-See `test coverage results <test_coverage/index.html>`_
+
+News
+----
+
+On November 24, 2016, we released version 2 of `pySDC`. This release contains major changes to the code and its structure:
+
+- **Complete redesign of code structure**: The ``core`` part of `pySDC` only contains the core modules and classes,
+  while ``implementations`` contains the actual implementations necessary to run something.
+  This now includes separate files for all collocation classes, as well as a collection of problems, transfer classes and so on.
+  Most examples have been ported to either ``tutorials``, ``playgrounds`` or ``projects``.
+
+- **Introduction of tutorials**: We added a tutorial (see below) to explain many
+  of pySDC's features in a step-by-step fashion. We start with a simple spatial
+  discretization and collocation formulations and move step by step to SDC, MLSDC and PFASST.
+  All tutorials are accompanied by tests.
+
+- **New all-inclusive controllers**: Instead of having two PFASST controllers
+  which could also do SDC and MLSDC (and more), we now have four generic controllers
+  which can do all these methods, depending on the input. They are split into
+  two by two class: `MPI` and `NonMPI` for real or virtual parallelisim as well
+  as `classic` and `multigrid` for the standard and multigrid-like implementation
+  of PFASST and the likes. Initialization has been simplified a lot, too.
+
+- **Collocation-based coarsening** As the standard PFASST libraries `libpfasst <https://bitbucket.org/memmett/libpfasst>`_ and `PFASST++ <https://github.com/Parallel-in-Time/PFASST>`_
+  `pySDC` now offers collocation-based coarsening, i.e. the number of collocation nodes can be reduced during coarsening.
+  Also, time-step coarsening is in preparation, but not implemented yet.
+
+- **Testing and documentation** The core, implementations and plugin packages and their subpackages are fully documented using sphinx-apidoc, see below.
+  This documentation as well as this website are generated automatically using `Travis-CI <https://travis-ci.org/Parallel-in-Time/pySDC>`_.
+  Most of the code is supported by tests, mainly realized by using the tutorial as the test routines with clearly defined results. Also, projects are accompanied by tests.
+  Test coverage results can be found `here <test_coverage/index.html>`_.
+
+- Further, minor changes:
+
+  - Switched to more stable barycentric interpolation for the quadrature weights
+  - New collocation class: `EquidistantSpline_Right` for spline-based quadrature
+  - Collocation tests are realized by generators and not by classes
+  - Multi-step SDC (aka single-level PFASST) now works as expected
+  - Reworked many of the internal structures for consistency and simplicity
 
 
 Tutorial
@@ -30,27 +62,29 @@ Tutorial
    tutorial/step_6.rst
    tutorial/step_7.rst
 
+Playgrounds
+-----------
+.. include:: ../../playgrounds/README.rst
+
 Projects
 --------
 
+.. include:: ../../projects/README.rst
+
 .. toctree::
    :maxdepth: 2
 
    projects/parallelSDC.rst
    projects/node_failure.rst
    projects/fwsw.rst
 
-Playgrounds
------------
-.. include:: ../../playgrounds/README.rst
-
 API documentation
 -----------------
 
 .. include:: ../../pySDC/README.rst
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
 
    pySDC/pySDC.core.rst
    pySDC/pySDC.implementations.rst
@@ -64,3 +98,5 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+Also, see `test coverage results <test_coverage/index.html>`_.
+

projects/README.rst

@@ -0,0 +1,6 @@
+In the ``projects`` folder we gather focussed experiments with pySDC which go beyond simple toy problems or feature tests.
+In particular, projects are structured and documented codes which form the basis for publications or presentations.
+All projects are expected to contain a README file describing the intention and content of the work.
+Parts of the Python scripts are supported by tests and checked for PEP8 conformity.
+
+