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.
Website: https://github.com/LLNL/hiop
| Policy | Support | Notes |
|---|---|---|
| M1. Support portable installation through Spack. | Full | Fully-functional Spack package has been merged upstream. Our development team pushes updates continuously. |
| M2. Provide a comprehensive test suite for correctness of installation verification. | Full | HiOp contains many test drivers for end-to-end integration tests as well as about 240 unit tests for each key linear algebra kernel. |
| 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 | HiOp objects take an MPI communicator in the constructor. The only uses of MPI_COMM_WORLD are in the test drivers or as default parameters to functions that allow the user to set the communicator. |
| M4. Give best effort at portability to key architectures (standard Linux distributions, GNU, Clang, vendor compilers, and target machines at ALCF, NERSC, OLCF). | Full | Our continuous integration tests every branch on multiple platforms with multiple architectures. |
| M5. Provide a documented, reliable way to contact the development team. | Full | Submit issues here. |
| M6. Respect system resources and settings made by other previously called packages (e.g. signal handling). | Full | HiOp does not override any signal handlers. |
| M7. Come with an open source (BSD style) license. | Full | Use 3-clause BSD license. |
| M8. Provide a runtime API to return the current version number of the software. | Full | Header hiopVersion.hpp provides functions and data such as void version(int& major, int& minor, int& patch). Macros HIOP_VERSION_MAJOR/MINOR/PATCH are also defined for compile-time checks. |
| M9. Use a limited and well-defined symbol, macro, library, and include file name space. | Full | All symbols exist in a C++ namespace, and all macros are prefixed with HIOP_. |
| M10. Provide an xSDK team accessible repository (not necessarily publicly available). | Full | Public repository linked here. |
| M11. Have no hardwired print or IO statements that cannot be turned off. | Full | HiOp takes options to toggle verbosity level. |
| M12. For external dependencies, allow installing, building, and linking against an outside copy of external software. | Full | Our CMake configuration allows for linking against externally built packages. We use spack for dependency management. |
| M13. Install headers and libraries under <prefix>/include and <prefix>/lib. | Full | Searching the repository for the install keyword in CMakeLists.txt files reveals that headers and libraries are installed under <prefix>/include and <prefix>/lib. Additionally, installed CMake configurations are installed under <prefix>/share/hiop/cmake. |
| M14. Be buildable using 64 bit pointers. 32 bit is optional. | Full | HiOp has only been built with 64 bit pointers. |
| M15. All xSDK compatibility changes should be sustainable. | Full | All policies are addressed in the key development branch, develop, and do not only exist in a feature branch. |
| M16. Any xSDK-compatible package that compiles code should have a configuration option to build in Debug mode. | Full | Setting CMAKE_BUILD_TYPE to Debug at configure time will build HiOp with debugging symbols. This can also be set through Spack with the build_type variant. |
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 | Public repository on GitHub. |
| R2. Possible to run test suite under valgrind in order to test for memory corruption issues. | Full | None. |
| R3. Adopt and document consistent system for error conditions/exceptions. | Full | Linear algebra kernels use return codes for error handling. |
| R4. Free all system resources acquired as soon as they are no longer needed. | Partial | Some destructors free memory if this has not already been handled, indicating some resources may be under program acquisition longer than needed. |
| R5. Provide a mechanism to export ordered list of library dependencies. | Full | Header hiopVersion.hpp provides dynamic and static dependency information for key dependencies, particularly those related to GPU execution. HiOp also exports CMake targets. |
| R6. Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Full | Spack packages provide this information. Dependencies are also documented in the user manual in PDF form under the doc directory. |
| R7. Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Full | README.md, SUPPORT.md, COPYRIGHT, LICENSE, and CHANGELOG files exist in top-level directory. |
| R8. Each xSDK member package should have sufficient documentation to support use and further development. | Full | The doc directory contains a thorough user manual with detailed documentation on the interface. Additionally, the file README_developers.md contains guidelines developers must follow to contribute to HiOp and the src/LinAlg directory contains markup files documenting various assumptions used by the linear algebra kernels. Further documentation may be found in README_summit.md for development on Summit. |