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.
Website: https://github.com/SCOREC/core/wiki
Policy | Support | Notes |
---|---|---|
M1. Support xSDK community GNU Autoconf or CMake options. | Full | PUMI uses CMake. M1 details |
M2. Provide a comprehensive test suite for correctness of installation verification. | Full | PUMI has over 100 regression tests; a significant portion of the tests exercise parallel functionality. |
M3. Employ userprovided MPI communicator (no MPI_COMM_WORLD). | Full | None. (patch) |
M4. Give best effort at portability to key architectures (standard Linux distributions, GNU, Clang, vendor compilers, and target machines at ALCF, NERSC, OLCF). | Full | PUMI builds with GNU, XL and Clang compilers on ALCF Mira, Intel and GNU on ALCF Theta, and Intel and GNU on NERSC Cori. |
M5. Provide a documented, reliable way to contact the development team. | Full | None. |
M6. Respect system resources and settings made by other previously called packages (e.g. signal handling). | Full | None. |
M7. Come with an open source (BSD style) license. | Full | BSD 3-Clause "New" or "Revised" License. |
M8. Provide a runtime API to return the current version number of the software. | Full | None. (patch) |
M9. Use a limited and well-defined symbol, macro, library, and include file name space. | Full | None. |
M10. Provide an xSDK team accessible repository (not necessarily publicly available). | Full | https://github.com/SCOREC/core/ |
M11. Have no hardwired print or IO statements that cannot be turned off. | Full | None. |
M12. For external dependencies, allow installing, building, and linking against an outside copy of external software. | Full | None. |
M13. Install headers and libraries under <prefix>/include and <prefix>/lib. | Full | None. |
M14. Be buildable using 64 bit pointers. 32 bit is optional. | Full | We have not recently tested a 32 bit build. |
M15. All xSDK compatibility changes should be sustainable. | Full | None. |
M16. The package must support production-quality installation compatible with the xSDK install tool and xSDK metapackage. | Full | PUMI is a spack package. |
M1 details : Following the numbering in draft 0.3.0 of the xSDK Community Installation Policies: GNU Autoconf and CMake Options
<item #>. [supported=yes|no|description]
- yes
- yes
- yes
- yes
- yes
- not needed, we have a fortran interface specific for PHASTA interactions
- we only support double precision
- we don't support this - it could be used to control
MDS_ID_TYPE
, but that seems like a stretch - we don't use blas/lapack
- yes
- yes
- yes (https://github.com/cwsmith/core/commit/2b12df439deb581805272d87cfc0cb6b96e60054)
- yes - this is provided by the SCORECConfig.cmake file in the <install_prefix>/lib/cmake/SCOREC/ and build directory
Policy | Support | Notes |
---|---|---|
R1. Have a public repository. | Full | None. |
R2. Possible to run test suite under valgrind in order to test for memory corruption issues. | Full | There are cmake options to enable valgrind when running the ctest test suite. |
R3. Adopt and document consistent system for error conditions/exceptions. | None | None. |
R4. Free all system resources acquired as soon as they are no longer needed. | Full | None. |
R5. Provide a mechanism to export ordered list of library dependencies. | partial | We provide a CMake package for other users of CMake; example. |
R6. Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Partial | We specify the required versions of Omega_h and Simmetrix SimModSuite in our CMake files. The required ParMETIS, Zoltan, and BZip versions are not specified. |
R7. Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Partial | We provide README and LICENSE but not SUPPORT and CHANGELOG files. |