This document summarizes the efforts of current and future xSDK member packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available here and should be considered when filling out this form.
Please, provide information on your compatibility status for each mandatory policy, and if possible also for recommended policies. If you are not compatible, state what is lacking and what are your plans on how to achieve compliance.
For current xSDK member packages: If you were not fully compatible at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages.
Website: http://slepc.upv.es
| Policy | Support | Notes |
|---|---|---|
| M1. Support portable installation through Spack. | Full | SLEPc is installable via spack install slepc. |
| M2. Provide a comprehensive test suite for correctness of installation verification. | Full | PETSc has about 250 test examples, with a code coverage over 90%, and a test harness that can execute the examples in parallel. And they are run as part of CI (https://gitlab.com/slepc/slepc/-/pipelines). The CI verifies both prefix and non-prefix installations. |
| M3. Employ user-provided MPI communicator (no MPI_COMM_WORLD). Don't assume a full MPI 3 implementation without checking. Provide an option to prevent any changes to MPI error-handling if it is changed by default. | Full | All SLEPc objects take an MPI communicator in the constructor, allowing the user complete control over where each object exists and performs its computations. MPI3 functionality is currently used only via PETSc. |
| M4. Give best effort at portability to key architectures (standard Linux distributions, GNU, Clang, vendor compilers, and target machines at ALCF, NERSC, OLCF). | Full | The SLEPc test suite tests GNU, Clang, Intel and PGI compilers. Portability is mostly guaranteed by strict adherence to PETSc conventions. |
| M5. Provide a documented, reliable way to contact the development team. | Full | SLEPc developers can be contacted via issues on GitLab or via email to [email protected]. |
| M6. Respect system resources and settings made by other previously called packages (e.g. signal handling). | Full | Inherits PETSc behavior regarding signal handlers. |
| M7. Come with an open source (BSD style) license. | Full | Use 2-clause BSD license. |
| M8. Provide a runtime API to return the current version number of the software. | Full | SlepcGetVersion() and SlepcGetVersionNumber(). |
| M9. Use a limited and well-defined symbol, macro, library, and include file name space. | Full | SLEPc include files all begin with slepc. The libraries begin with libslepc. Macros and symbols begin with SLEPC or a small set of other prefixes. The symbol/macro space is larger than it should be since it has prefixes such as EPS, PEP, ST. These are not namespaced, following a similar philosophy as in PETSc. We have not had reports of symbol conflicts with other libraries. |
| M10. Provide an xSDK team accessible repository (not necessarily publicly available). | Full | https://gitlab.com/slepc/slepc. |
| M11. Have no hardwired print or IO statements that cannot be turned off. | Full | Same behavior as PETSc, with output turned off by default. |
| M12. For external dependencies, allow installing, building, and linking against an outside copy of external software. | Full | For most external packages xxx, SLEPc supports both the configure option --with-xxx-dir to use an externally built version and --download-xxx to install the package. SLEPc does not contain any other package's source code within. |
| M13. Install headers and libraries under <prefix>/include and <prefix>/lib. | Full | SLEPc's configure uses the usual --prefix option. |
| M14. Be buildable using 64 bit pointers. 32 bit is optional. | Full | Supports both 32 and 64 bit under same API. |
| M15. All xSDK compatibility changes should be sustainable. | Full | Any functionality required by xSDK will be incorporated as necessary in the base source code. |
| M16. Any xSDK-compatible package that compiles code should have a configuration option to build in Debug mode. | Full | SLEPc uses PETSc's configure --with-debugging=0/1 option. |
M1 details : optional: provide more details about approach to addressing topic M1.
M2 details : optional: provide more details about approach to addressing topic M2.
| Policy | Support | Notes |
|---|---|---|
| R1. Have a public repository. | Full | https://gitlab.com/slepc/slepc. |
| R2. Possible to run test suite under valgrind in order to test for memory corruption issues. | Full | SLEPc has this capacity and runs the test suite under valgrind for CI. |
| R3. Adopt and document consistent system for error conditions/exceptions. | Full | Similar to PETSc, SLEPc uses error codes from Fortran and C/C++ to report all error conditions. After each function is called the error code is checked to determine whether the code can continue or must be terminated. It uses this checking to produce stack traces by default when errors are detected. |
| R4. Free all system resources acquired as soon as they are no longer needed. | Full | Similar to PETSc, SLEPc tests use valgrind, and internal code to report any resources or memory that are not freed before the program completes. |
| R5. Provide a mechanism to export ordered list of library dependencies. | Full | The command make getlinklibs_slepc lists all dependencies for an install; SLEPc also provides pkgconfig and module files. |
| R6. Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Partial | This is curently documented in ./configure --help as well as the Users manual. |
| R7. Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Full | Provides README, CONTRIBUTING, LICENSE, and CHANGELOG in repo. |
| R8. Each xSDK member package should have sufficient documentation to support use and further development. | Partial | Documentation currently supports use only, there is no documentation for developers. |