Skip to content

Commit 7dcfada

Browse files
committed
README update and version push
1 parent 8014fca commit 7dcfada

File tree

2 files changed

+40
-35
lines changed

2 files changed

+40
-35
lines changed

docs/source/index.rst

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,45 @@ The code is hosted on GitHub, see `https://github.com/Parallel-in-Time/pySDC <ht
1111
News
1212
----
1313

14-
On November 24, 2016, we released version 2 of `pySDC`. This release contains major changes to the code and its structure:
15-
16-
- **Complete redesign of code structure**: The ``core`` part of `pySDC` only contains the core modules and classes,
17-
while ``implementations`` contains the actual implementations necessary to run something.
18-
This now includes separate files for all collocation classes, as well as a collection of problems, transfer classes and so on.
19-
Most examples have been ported to either ``tutorials``, ``playgrounds`` or ``projects``.
20-
21-
- **Introduction of tutorials**: We added a tutorial (see below) to explain many
22-
of pySDC's features in a step-by-step fashion. We start with a simple spatial
23-
discretization and collocation formulations and move step by step to SDC, MLSDC and PFASST.
24-
All tutorials are accompanied by tests.
25-
26-
- **New all-inclusive controllers**: Instead of having two PFASST controllers
27-
which could also do SDC and MLSDC (and more), we now have four generic controllers
28-
which can do all these methods, depending on the input. They are split into
29-
two by two class: `MPI` and `NonMPI` for real or virtual parallelisim as well
30-
as `classic` and `multigrid` for the standard and multigrid-like implementation
31-
of PFASST and the likes. Initialization has been simplified a lot, too.
32-
33-
- **Collocation-based coarsening** As the standard PFASST libraries `libpfasst <https://bitbucket.org/memmett/libpfasst>`_ and `PFASST++ <https://github.com/Parallel-in-Time/PFASST>`_
34-
`pySDC` now offers collocation-based coarsening, i.e. the number of collocation nodes can be reduced during coarsening.
35-
Also, time-step coarsening is in preparation, but not implemented yet.
36-
37-
- **Testing and documentation** The core, implementations and plugin packages and their subpackages are fully documented using sphinx-apidoc, see below.
38-
This documentation as well as this website are generated automatically using `Travis-CI <https://travis-ci.org/Parallel-in-Time/pySDC>`_.
39-
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.
40-
41-
- Further, minor changes:
42-
43-
- Switched to more stable barycentric interpolation for the quadrature weights
44-
- New collocation class: `EquidistantSpline_Right` for spline-based quadrature
45-
- Collocation tests are realized by generators and not by classes
46-
- Multi-step SDC (aka single-level PFASST) now works as expected
47-
- Reworked many of the internal structures for consistency and simplicity
14+
- For the `6th Workshop on Parallel-in-Time Integration <https://www.ics.usi.ch/index.php/6th-workshop-on-parallel-in-time-methods>`_
15+
`pySDC` has been updated to version 2.1. It is now available on PyPI - the Python Package Index, see `https://pypi.python.org/pypi/pySDC <https://pypi.python.org/pypi/pySDC>`_
16+
and can be installed simply by using ``pip install pySDC``. Naturally, this release contains a lot of bugfixes and minor improvements.
17+
Most notably, the file structure has been changes again to meet the standards for Python packaging (at least a bit).
18+
19+
- On November 24, 2016, we released version 2 of `pySDC`. This release contains major changes to the code and its structure:
20+
21+
- **Complete redesign of code structure**: The ``core`` part of `pySDC` only contains the core modules and classes,
22+
while ``implementations`` contains the actual implementations necessary to run something.
23+
This now includes separate files for all collocation classes, as well as a collection of problems, transfer classes and so on.
24+
Most examples have been ported to either ``tutorials``, ``playgrounds`` or ``projects``.
25+
26+
- **Introduction of tutorials**: We added a tutorial (see below) to explain many
27+
of pySDC's features in a step-by-step fashion. We start with a simple spatial
28+
discretization and collocation formulations and move step by step to SDC, MLSDC and PFASST.
29+
All tutorials are accompanied by tests.
30+
31+
- **New all-inclusive controllers**: Instead of having two PFASST controllers
32+
which could also do SDC and MLSDC (and more), we now have four generic controllers
33+
which can do all these methods, depending on the input. They are split into
34+
two by two class: `MPI` and `NonMPI` for real or virtual parallelisim as well
35+
as `classic` and `multigrid` for the standard and multigrid-like implementation
36+
of PFASST and the likes. Initialization has been simplified a lot, too.
37+
38+
- **Collocation-based coarsening** As the standard PFASST libraries `libpfasst <https://bitbucket.org/memmett/libpfasst>`_ and `PFASST++ <https://github.com/Parallel-in-Time/PFASST>`_
39+
`pySDC` now offers collocation-based coarsening, i.e. the number of collocation nodes can be reduced during coarsening.
40+
Also, time-step coarsening is in preparation, but not implemented yet.
41+
42+
- **Testing and documentation** The core, implementations and plugin packages and their subpackages are fully documented using sphinx-apidoc, see below.
43+
This documentation as well as this website are generated automatically using `Travis-CI <https://travis-ci.org/Parallel-in-Time/pySDC>`_.
44+
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.
45+
46+
- Further, minor changes:
47+
48+
- Switched to more stable barycentric interpolation for the quadrature weights
49+
- New collocation class: `EquidistantSpline_Right` for spline-based quadrature
50+
- Collocation tests are realized by generators and not by classes
51+
- Multi-step SDC (aka single-level PFASST) now works as expected
52+
- Reworked many of the internal structures for consistency and simplicity
4853

4954

5055
Tutorial

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name='pySDC',
8-
version='2.0',
8+
version='2.1',
99
description='A Python implementation of spectral deferred correction methods and the likes',
1010
license="BSD-2",
1111
long_description=long_description,

0 commit comments

Comments
 (0)