Skip to content

Commit

Permalink
docu: prepare release notes for 0.5.0
Browse files Browse the repository at this point in the history
Signed-off-by: Torbjörn Klatt <[email protected]>
  • Loading branch information
torbjoernk committed May 18, 2015
1 parent 44e6d86 commit b3f4f24
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 1 deletion.
84 changes: 84 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,89 @@
# Changelog {#page_changelog}

## v0.5.0 -- The MPI Bugfix Release (2015/05/XX)

DOI: []()

$
>

### Notable Features

* random deadlocks with various setups due to open and unused MPI request handlers
([#210][], [#212][], [#216][])

* PFASST with one processor was not MLSDC
([#193][], [#196][])

* MPI is now the default when compiling
([#197][])

* expected quadrature error now calculated and logged
([#206][])

* runtime parameters can now also be read from config file instead of command line
([#199][])

* colourful logging can now be disabled via runtime flag
([#202][])

* file name for logs can be specified via runtime parameters
([#203][])

### Details

* `VectorEncapsulation` and `MPIVectorEncapsulation` merged into one
([#176][], [#200][])

* version now set by Python script not requireing recompilation of everything when not changed
([#195][])

* various enhancements and fixes of build system
([#201][], [#211][])

* little code cleanup
([#194][], [#204][], [#205][], [#208][])

* some documentation
([#191][], [#207][])

[#176]: https://github.com/Parallel-in-Time/PFASST/pull/176
[#191]: https://github.com/Parallel-in-Time/PFASST/pull/191
[#193]: https://github.com/Parallel-in-Time/PFASST/pull/193
[#194]: https://github.com/Parallel-in-Time/PFASST/pull/194
[#195]: https://github.com/Parallel-in-Time/PFASST/pull/195
[#196]: https://github.com/Parallel-in-Time/PFASST/pull/196
[#197]: https://github.com/Parallel-in-Time/PFASST/pull/197
[#199]: https://github.com/Parallel-in-Time/PFASST/pull/199
[#200]: https://github.com/Parallel-in-Time/PFASST/pull/200
[#201]: https://github.com/Parallel-in-Time/PFASST/pull/201
[#202]: https://github.com/Parallel-in-Time/PFASST/pull/202
[#203]: https://github.com/Parallel-in-Time/PFASST/pull/203
[#204]: https://github.com/Parallel-in-Time/PFASST/pull/204
[#205]: https://github.com/Parallel-in-Time/PFASST/pull/205
[#206]: https://github.com/Parallel-in-Time/PFASST/pull/206
[#207]: https://github.com/Parallel-in-Time/PFASST/pull/207
[#208]: https://github.com/Parallel-in-Time/PFASST/pull/208
[#210]: https://github.com/Parallel-in-Time/PFASST/pull/210
[#211]: https://github.com/Parallel-in-Time/PFASST/pull/211
[#212]: https://github.com/Parallel-in-Time/PFASST/pull/212
[#216]: https://github.com/Parallel-in-Time/PFASST/pull/216

### Contributors

* Matthew Emmett, Lawrence Berkeley National Laboratory ([memmett][])
* Torbjörn Klatt, Jülich Supercomputing Centre ([torbjoernk][])
* Daniel Ruprecht, Institute of Computational Science, University of Lugano ([danielru][])
* Robert Speck, Jülich Supercomputing Centre ([pancetta][])
* Selman Terzi, Jülich Supercomputing Centre ([selmanTerzi][])

[memmett]: https://github.com/memmett
[torbjoernk]: https://github.com/torbjoernk
[danielru]: https://github.com/danielru
[pancetta]: https://github.com/pancetta
[selmanTerzi]: https://github.com/selmanTerzi


## v0.4.0 -- The Big Improvement (2015/04/17)

DOI: [10.6084/m9.figshare.1381721](http://dx.doi.org/10.6084/m9.figshare.1381721)
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ spectral deferred correction* (MLSDC) algorithms.
News
----

* April 17, 2014: PFASST v0.4.0 release. Please see the [release notes](#releases) for more
* May XX, 2015: PFASST v0.5.0 release. Please see the [release notes](#releases) for more
information.

* April 17, 2015: PFASST v0.4.0 release. Please see the [release notes](#releases) for more
information.

* December 12, 2014: PFASST v0.3.0 release. Please see the [release notes](#releases) for more
Expand Down Expand Up @@ -47,6 +50,12 @@ Currently, it features the following content:
Releases
--------

* **v0.5.0** The MPI Bugfix Release (2015/05/XX)

A few important fixes to MPI behaviour.
DOI: [][DOI_v050].
See [the Changelog](#page_changelog) for details.

* **v0.4.0** The Big Improvement (2015/04/17)

A bunch of improvements and usability enhancements.
Expand Down Expand Up @@ -75,6 +84,7 @@ Releases
[DOI_v020]: http://dx.doi.org/10.5281/zenodo.11517
[DOI_v030]: http://dx.doi.org/10.5281/zenodo.13221
[DOI_v040]: http://dx.doi.org/10.6084/m9.figshare.1381721
[DOI_v050]:

Release tags will be signed by one of the following PGP keys:

Expand Down
8 changes: 8 additions & 0 deletions include/pfasst/mpi_communicator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ using namespace std;
*
* @returns _empty_ `MPI_Status` object
*
* @since v0.5.0
*
* @ingroup Utilities
*/
inline static MPI_Status MPI_Status_factory()
Expand Down Expand Up @@ -52,6 +54,12 @@ namespace pfasst
*
* In case @p err_code is not `MPI_SUCCESS` this throws MPIError with the error code looked up
* to a descriptive string as defined by the MPI implementation.
*
* @param[in] err_code MPI error code as returned from an MPI call
*
* @since v0.5.0
*
* @ingroup Utilities
*/
inline static void check_mpi_error(const int err_code)
{
Expand Down

0 comments on commit b3f4f24

Please sign in to comment.