Commit cbb4e0c7 authored by Andreas Marek's avatar Andreas Marek

Start to prepare release candidate rc1 of ELPA 2020.05.001

parent c3215b87
......@@ -2,21 +2,17 @@
## Preamble ##
This file provides documentation on how to build the *ELPA* library in **version ELPA-2019.11.001**.
This file provides documentation on how to build the *ELPA* library in **version ELPA-2020.05.001.rc1**.
With release of **version ELPA-2017.05.001** the build process has been significantly simplified,
which makes it easier to install the *ELPA* library.
The old, obsolete legacy API will be deprecated in the future !
Already now, all new features of ELPA are only available with the new API. Thus, there
is no reason to keep the legacy API around for too long.
The release ELPA 2018.11.001 was the last release, where the legacy API has been
enabled by default (and can be disabled at build time).
With release ELPA 2019.05.001 the legacy API is disabled by default, however,
can be still switched on at build time.
With this release ELPA 2019.11.001, the legacy API will be deprecated and not supported anymore.
The release of ELPA 2019.11.001 does change the API and ABI compared to the release 2019.05.002, since
The release of ELPA 2020.05.001.rc1 does change the API and ABI compared to the release 2019.05.002, since
the legacy API has been dropped.
## How to install *ELPA* ##
......@@ -79,6 +75,7 @@ An excerpt of the most important (*ELPA* specific) options reads as follows:
| `--with-default-real-kernel=KERNEL` | set the real kernel KERNEL as default |
| `--with-default-complex-kernel=KERNEL`| set the compplex kernel KERNEL as default |
| `--enable-scalapack-tests` | build SCALAPACK test cases for performance <br> omparison, needs MPI, default no. |
| `--enable-autotune-redistribute-matrix` | EXPERIMENTAL FEATURE; NOT FULLY SUPPORTED YET: Allows ELPA during autotuning to re-distribute the matrix to find the best (ELPA internal) block size for block-cyclic distribution (Needs Scalapack functionality |
| `--enable-autotuning` | enables autotuning functionality, default yes |
| `--enable-c-tests` | enables the C tests for elpa, default yes |
| `--disable-assumed-size` | do NOT use assumed-size Fortran arrays. default use |
......
......@@ -3,6 +3,9 @@
For more details and recent updates please visit the online [issue system](https://gitlab.mpcdf.mpg.de/elpa/elpa/issues)
Issues which are not mentioned in a newer release are (considered as) solved.
### ELPA 2020.05.001.rc1 release ###
- no other issues currently known
### ELPA 2019.11.001 release ###
- memory leak in in GPU version has been fixed
- no other issues currently known
......
......@@ -102,6 +102,10 @@ Nonetheless, we are grateful if you cite the following publications:
Numerical Mathematics and Advanced Applications ENUMATH 2017. ENUMATH 2017.
Lecture Notes in Computational Science and Engineering, vol 126. Springer, Cham
Yu, V.; Moussa, J.; Kus, P.; Marek, A.; Messmer, P.; Yoon, M.; Lederer, H.; Blum, V.
"GPU-Acceleration of the ELPA2 Distributed Eigensolver for Dense Symmetric and Hermitian Eigenproblems",
https://arxiv.org/abs/2002.10991
If you use the new API and/or autotuning:
Kus, P.; Marek, A.; Koecher, S. S.; Kowalski H.-H.; Carbogno, Ch.; Scheurer, Ch.; Reuter, K.; Scheffler, M.; Lederer, H.
......@@ -131,8 +135,7 @@ the possible configure options.
## Using *ELPA*
Please have a look at the [USERS_GUIDE](USERS_GUIDE.md) file, to get a documentation or at the [online](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2019.11.001/html/index.html) doxygen
documentation, where you find the definition of the interfaces.
Please have a look at the [USERS_GUIDE](USERS_GUIDE.md) file, to get a documentation or at the [online](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2020.05.001.rc1/html/index.html) doxygen documentation, where you find the definition of the interfaces.
## Contributing to *ELPA*
......
This file contains the release notes for the ELPA 2019.11.001 version
This file contains the release notes for the ELPA 2020.05.001.rc1 version
What is new?
-------------
For detailed information about changes since release ELPA 2019.05.002 please have a look at the Changelog file
For detailed information about changes since release ELPA 2019.11.001 please have a look at the Changelog file
- improved GPU version of ELPA 2stage
- some new experimental features
- bugfixes
- several new features have been implemented
- the old, legacy interface has been removed
ABI change
---------------------
Since release 2019.05.002 the ABI has changed, since the legacy interface cannot be activated anymore
Since release 2019.11.001 the ABI has not changed.
Any incompatibilities to previous version?
---------------------------------------
......
......@@ -146,7 +146,7 @@ Local documentation (via man pages) should be available (if *ELPA* has been inst
For example `man elpa2_print_kernels` should provide the documentation for the *ELPA* program which prints all
the available kernels.
Also a [online doxygen documentation](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2019.11.001/html/index.html)
Also a [online doxygen documentation](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2020.05.001.rc1/html/index.html)
for each *ELPA* release is available.
......@@ -14,7 +14,7 @@ Local documentation (via man pages) should be available (if *ELPA* has been inst
For example `man elpa2_print_kernels` should provide the documentation for the *ELPA* program, which prints all
the available kernels.
Also a [online doxygen documentation](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2019.11.001/html/index.html)
Also a [online doxygen documentation](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2020.05.001.rc1/html/index.html)
for each *ELPA* release is available.
......@@ -187,7 +187,7 @@ The following table gives a list of all supported parameters which can be used t
## III) List of computational routines ##
The following compute routines are available in *ELPA*: Please have a look at the man pages or [online doxygen documentation] (http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2019.11.001/html/index.html) for details.
The following compute routines are available in *ELPA*: Please have a look at the man pages or [online doxygen documentation] (http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2020.05.001.rc1/html/index.html) for details.
| Name | Purpose | since API version |
......
......@@ -22,7 +22,7 @@ The *ELPA* library consists of two main parts:
Both variants of the *ELPA* solvers are available for real or complex singe and double precision valued matrices.
Thus *ELPA* provides the following user functions (see man pages or [online](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2019.11.001/html/index.html) for details):
Thus *ELPA* provides the following user functions (see man pages or [online](http://elpa.mpcdf.mpg.de/html/Documentation/ELPA-2020.05.001.rc1/html/index.html) for details):
- elpa_get_communicators : set the row / column communicators for *ELPA*
- elpa_solve_evp_complex_1stage_{single|double} : solve a {single|double} precision complex eigenvalue proplem with the *ELPA 1stage* solver
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment