This document provides the guide for using the *ELPA* library with the new API (API version 20170403 or higher).
If you need instructions on how to build *ELPA*, please look at [INSTALL.md] (INSTALL.md).
If you need instructions on how to build *ELPA*, please look at [INSTALL document](INSTALL.md).
### Online and local documentation ###
...
...
@@ -11,7 +11,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-2023.05.001/html/index.html)
Also a [online doxygen documentation](https://elpa.mpcdf.mpg.de/documentation/doxygen/ELPA_DOXYGEN_PAGES/ELPA-2023.11.001/html/index.html)
for each *ELPA* release is available.
...
...
@@ -68,7 +68,7 @@ Fortran synopsis
if(elpa_init(20171201)/=ELPA_OK)then! put here the API version that you are using
print*,"ELPA API version not supported"
stop
stop1
endif
elpa=>elpa_allocate(success)
if(success!= ELPA_OK) then
...
...
@@ -178,7 +178,9 @@ 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-2023.05.001/html/index.html) for details.
The following compute routines are available in *ELPA*: Please have a look at the man pages or
@@ -225,7 +227,7 @@ This is necessary to make the threading an autotunable option.
For each tunable parameter mentioned in Section II, there exists a default value. This means, that if this parameter is **not explicitly** set by the user by the
*ELPA* set method, *ELPA* takes the default value for the parameter. E.g. if the user does not set a solver method, than *ELPA* will take the default 1`ELPA_SOLVER_1STAGE`.
The user can change this default value by setting an enviroment variable to the desired value.
The user can change this default value by setting an environment variable to the desired value.
The name of this variable is always constructed in the following way: