diff --git a/amrex-policy-compatibility.md b/amrex-policy-compatibility.md index 0272572..acc6d3e 100644 --- a/amrex-policy-compatibility.md +++ b/amrex-policy-compatibility.md @@ -1,14 +1,18 @@ # xSDK Community Policy Compatibility for AMReX -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. Please, provide information on your compability 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 compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://github.com/AMReX-Codes/amrex +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -41,4 +45,4 @@ For current xSDK member packages: If you were not compliant at some point, pleas |**R5.** Provide a mechanism to export ordered list of library dependencies. | No| None.| |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |None| None. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| None. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Partial| There are sphinx and doxygen documentations for usage as well as tutorial codes. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Partial| There are sphinx and doxygen documentations for usage as well as tutorial codes. | diff --git a/arborx-policy-compatibility.md b/arborx-policy-compatibility.md index 7abbae3..bb6cef7 100644 --- a/arborx-policy-compatibility.md +++ b/arborx-policy-compatibility.md @@ -2,6 +2,8 @@ **Website:** https://github.com/arborx/ArborX +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -34,4 +36,4 @@ |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Via `CMake`. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Full | Via `CMake`. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| https://github.com/arborx/ArborX/blob/master/README.md, https://github.com/arborx/ArborX/blob/master/LICENSE, https://github.com/arborx/ArborX/blob/master/CHANGELOG.md. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| https://github.com/arborx/ArborX/wiki | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| https://github.com/arborx/ArborX/wiki | diff --git a/blas++-policy-compatibility.md b/blas++-policy-compatibility.md index 4f97d1d..b977598 100644 --- a/blas++-policy-compatibility.md +++ b/blas++-policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for BLAS++ -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [PETSc version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/petsc-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [http://icl.utk.edu/slate/](http://icl.utk.edu/slate/) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +52,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Exports dependencies via CMake. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Via Spack. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| Has README.md, LICENSE, CHANGELOG.md. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| [Online docs](https://github.com/icl-utk-edu/blaspp#documentation). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| [Online docs](https://github.com/icl-utk-edu/blaspp#documentation). | diff --git a/butterflypack-policy-compatibility.md b/butterflypack-policy-compatibility.md index 4d590f4..7cce27b 100644 --- a/butterflypack-policy-compatibility.md +++ b/butterflypack-policy-compatibility.md @@ -1,12 +1,16 @@ # xSDK Community Policy Compatibility for ButterflyPACK -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) 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 compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages. +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 packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://github.com/liuyangzhuan/ButterflyPACK +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -39,5 +43,5 @@ Please, provide information on your compatibility status for each mandatory poli |**R5.** Provide a mechanism to export ordered list of library dependencies. |No| | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |No| | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| ButterflyPACK has a README and LICENSE file. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |No| The user document is under development. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |No| The user document is under development. | diff --git a/dealii-policy-compatibility.md b/dealii-policy-compatibility.md index d657967..36521fc 100644 --- a/dealii-policy-compatibility.md +++ b/dealii-policy-compatibility.md @@ -2,6 +2,8 @@ **Website:** https://www.dealii.org/ +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -40,4 +42,4 @@ See https://www.dealii.org/developer/developers/testsuite.html |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Via cmake. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial| In the readme file. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| README, SUPPORT, and LICENSE yes. The CHANGELOG is autogenerated as an HTML file from other information | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| Extensive documentation of all aspects. | \ No newline at end of file +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| Extensive documentation of all aspects. | diff --git a/dtk-policy-compatibility.md b/dtk-policy-compatibility.md index 6084850..cfda349 100644 --- a/dtk-policy-compatibility.md +++ b/dtk-policy-compatibility.md @@ -2,6 +2,8 @@ **Website:** https://github.com/ORNL-CEES/DataTransferKit +**Member:** yes + ### Mandatory Policies | Policy | Support | Notes | @@ -34,4 +36,4 @@ | **R5.** Provide a mechanism to export ordered list of library dependencies. | Full | Via `CMake`. | | **R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Full | Via `CMake`. | | **R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Partial | https://github.com/ORNL-CEES/DataTransferKit/blob/master/README.md, https://github.com/ORNL-CEES/DataTransferKit/blob/master/LICENSE. | -| **R8.** Each xSDK member package should have sufficient documentation to support use and further development. | Partial | https://datatransferkit.readthedocs.io/en/latest | +| **R8.** Each xSDK package should have sufficient documentation to support use and further development. | Partial | https://datatransferkit.readthedocs.io/en/latest | diff --git a/exago-policy-compatibility.md b/exago-policy-compatibility.md index ceec4b8..88f78ec 100644 --- a/exago-policy-compatibility.md +++ b/exago-policy-compatibility.md @@ -1,13 +1,17 @@ # xSDK Community Policy Compatibility for ExaGO -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. Please, provide information on your compability 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. +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. + **Website:** https://gitlab.pnnl.gov/exasgd/frameworks/exago +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -44,4 +48,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| ExaGO exposes two arrays, `ExaGODependencyNames` and `ExaGOIsDependencyEnabled`, allowing users to query dependency information. Only key dependencies are tracked in these arrays, such as RAJA and GPU-related dependencies. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Our Spack packages document much of this information. Documentation in [`INSTALL.md`](INSTALL.md) and [`docs/InstallingWithSpack.md`](docs/InstallingWithSpack.md) contain additional information about dependencies.| |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full| We currently have README.md, CHANGELOG.md, SUPPORT.md, and LICENSE files in root directory. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| The directory `docs/manual` contains thorough documentation in LaTeX with a prebuilt user manual PDF [linked here](docs/manual/manual.pdf). The file [`docs/DeveloperGuidelines`](./docs/DeveloperGuidelines.md) contains documentation on software development best practices that contributors are expected to follow. `docs/web` contains markdown documentation on each of the application libraries and further documentation on some dependencies and platforms. `docs/petsc-dependencies` contains further documentation on PETSc usage. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| The directory `docs/manual` contains thorough documentation in LaTeX with a prebuilt user manual PDF [linked here](docs/manual/manual.pdf). The file [`docs/DeveloperGuidelines`](./docs/DeveloperGuidelines.md) contains documentation on software development best practices that contributors are expected to follow. `docs/web` contains markdown documentation on each of the application libraries and further documentation on some dependencies and platforms. `docs/petsc-dependencies` contains further documentation on PETSc usage. | diff --git a/fftx-policy-compatibility.md b/fftx-policy-compatibility.md index 9c8cc3c..af3af27 100644 --- a/fftx-policy-compatibility.md +++ b/fftx-policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for FFTX -This document summarizes the efforts of current and future xSDK member packages to achieve compatibility with the xSDK community policies version 1.0.0. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies version 1.0.0. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [hypre version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/hypre-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://spiral-software.github.io/fftx/ +**Member:** no + ### Mandatory Policies | Policy |Support| Notes | @@ -32,7 +36,7 @@ For current xSDK member packages: If you were not fully compatible at some point |**M14.** Be buildable using 64 bit pointers. 32 bit is optional. |Full| FFTX all builds with 64-bit pointers by default. | |**M15.** All xSDK compatibility changes should be sustainable. |Full| All changes or updates will be applied to development and release versions by policy. | |**M16.** Have a debug build option. |Full| When building FFTX with CMake, the flag `-DCMAKE_BUILD_TYPE=Debug` enables debug mode. | -|**M17.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| Full documentation for usage, example codes, and instructions for developers are at https://spiral-software.github.io/fftx/. | +|**M17.** Each xSDK package should have sufficient documentation to support use and further development. |Full| Full documentation for usage, example codes, and instructions for developers are at https://spiral-software.github.io/fftx/. | ### Recommended Policies diff --git a/ginkgo-policy-compatibility.md b/ginkgo-policy-compatibility.md index 18cbe8e..e4aa652 100644 --- a/ginkgo-policy-compatibility.md +++ b/ginkgo-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for Ginkgo -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [ginkgo-project.github.io](https://ginkgo-project.github.io/) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -43,4 +47,4 @@ For current xSDK member packages: If you were not fully compatible at some point |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| This information is available through a pkg-config file and the CMake exported targets. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial|This is documented in our main `README.md`, but currently not in a machine readable form. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full | Ginkgo provides `README.md`, `LICENSE` and `CHANGELOG.md` files. Support information is available as part of the `README.md`. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| Full documentation can be found both in user and developer mode. A series of tutorial and many examples are available for using Ginkgo. We have specific guidelines and tutorials for future developers as well (for example, regarding important C++ aspects). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| Full documentation can be found both in user and developer mode. A series of tutorial and many examples are available for using Ginkgo. We have specific guidelines and tutorials for future developers as well (for example, regarding important C++ aspects). | diff --git a/heffte-policy-compatibility.md b/heffte-policy-compatibility.md index dbad2cf..eb60ca0 100644 --- a/heffte-policy-compatibility.md +++ b/heffte-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for heFFTe -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://mkstoyanov.bitbucket.io/heffte/ +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | diff --git a/hiop-policy-compatibility.md b/hiop-policy-compatibility.md index 1309b37..4c26bb8 100644 --- a/hiop-policy-compatibility.md +++ b/hiop-policy-compatibility.md @@ -1,13 +1,17 @@ # xSDK Community Policy Compatibility for HiOp -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) 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. +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. + **Website:** https://github.com/LLNL/hiop +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -44,4 +48,4 @@ M2 details : optional: provide more details about approac |**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. | +|**R8.** Each xSDK 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. | diff --git a/hypre-policy-compatibility.md b/hypre-policy-compatibility.md index 08cda9f..8efb180 100644 --- a/hypre-policy-compatibility.md +++ b/hypre-policy-compatibility.md @@ -1,13 +1,13 @@ # xSDK Community Policy Compatibility for *hypre* -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [hypre version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/hypre-policy-compatibility.md). Please, provide information on your compability 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 compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK packages. **Web site**: http://www.llnl.gov/casc/hypre @@ -31,7 +31,7 @@ For current xSDK member packages: If you were not compliant at some point, pleas |**M14.** Be buildable using 64 bit pointers. 32 bit is optional. |Full| None. | |**M15.** All xSDK compatibility changes should be sustainable. |Full| Every effort is made for *hypre* to be backwards compatible. | |**M16.** Have a debug build option. |Full| *hypre* provides such an option with --enable-debug. | -|**M17.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| There is full documentation for usage, example codes, as well as instructions for developers, see https://github.com/hypre-space/hypre/wiki. | +|**M17.** Each xSDK package should have sufficient documentation to support use and further development. |Full| There is full documentation for usage, example codes, as well as instructions for developers, see https://github.com/hypre-space/hypre/wiki. | ### Recommended Policies diff --git a/lapack++--policy-compatibility.md b/lapack++--policy-compatibility.md index 2d80814..f05839d 100644 --- a/lapack++--policy-compatibility.md +++ b/lapack++--policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for LAPACK++ -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [PETSc version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/petsc-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [http://icl.utk.edu/slate/](http://icl.utk.edu/slate/) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +52,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Exports dependencies via CMake. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Via Spack. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| Has README.md, LICENSE, CHANGELOG.md. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| [Online docs](https://github.com/icl-utk-edu/lapackpp#documentation). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| [Online docs](https://github.com/icl-utk-edu/lapackpp#documentation). | diff --git a/libensemble-policy-compatibility.md b/libensemble-policy-compatibility.md index d49c08d..12c260c 100644 --- a/libensemble-policy-compatibility.md +++ b/libensemble-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for libEnsemble -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://github.com/Libensemble/libensemble +**Member:** yes + ### Mandatory Policies [General libEnsemble Note](#liben-note) @@ -55,7 +59,7 @@ A special exception exists in the `node_resources.py` module; part of libEnsembl |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| The dependencies for libEnsemble are given in `setup.py` and when pip install or pip setup.py egg_info are run, a file is created `libensemble.egg-info/requires.txt` containing the list of required and optional dependencies. If installing through pip, these will automatically be installed if they do not exist (`pip install libensemble` installs req. dependencies, while `pip install libensemble[extras]` installs both required and optional dependencies.| |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Dependencies are given in the documentation. In some cases, this includes a lower bound on the version number. These dependencies are also specified in the Spack package, and automatically resolved during installation.| |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full| These files are present in the top directory.| -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full|libEnsemble provides documentation through a *Sphinx* framework. It is published on [readthedocs](https://libensemble.readthedocs.io), which includes a user guide covering quick-start, installation, an auto-generated API, and many usage details. There are several tutorials which contain complete examples. There is also an FAQ, known issues, release notes and contribution guide. The developer guide contains information on workflow and internal modules. A [pdf](https://libensemble.readthedocs.io/_/downloads/en/master/pdf/) version is also automatically generated.| +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full|libEnsemble provides documentation through a *Sphinx* framework. It is published on [readthedocs](https://libensemble.readthedocs.io), which includes a user guide covering quick-start, installation, an auto-generated API, and many usage details. There are several tutorials which contain complete examples. There is also an FAQ, known issues, release notes and contribution guide. The developer guide contains information on workflow and internal modules. A [pdf](https://libensemble.readthedocs.io/_/downloads/en/master/pdf/) version is also automatically generated.| R3 details : libEnsemble catches all exceptions (explicitly raised and unexpected) from the manager and worker processes, resulting in a dump of the ensemble state to files. In `mpi4py` mode, the default is to then call MPI_ABORT to prevent a hang. However, this can be turned off (via the `libE_specs` argument). In the case it is turned off, or if other communication modes are used, the exception is then raised. The user can in turn catch these exceptions from their calling script. diff --git a/magma-policy-compatibility.md b/magma-policy-compatibility.md index 3151377..7e55ac0 100644 --- a/magma-policy-compatibility.md +++ b/magma-policy-compatibility.md @@ -1,7 +1,7 @@ # xSDK Community Policy Compatibility for MAGMA In this document, we present a summary the continuing efforts of the current -and future xSDK member packages to achieve compatibility with the xSDK +and future xSDK packages to achieve compatibility with the xSDK community policies. What is available below is only a short description of each item of the policy. The full description is available as an [online document](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) @@ -13,12 +13,16 @@ their are applicable or have been implemented. If the package is not compatible, it is stated what is lacking and what are the specific plans on how to achieve compliance. -For current xSDK member packages: non-compliance at some point in time should +For current xSDK packages: non-compliance at some point in time should be described and the steps that were undertaken to fulfill the policy. This -information should be helpful for future xSDK member packages. +information should be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [MAGMA website on GitHub](https://github.com/icl-utk-edu/magma/) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | diff --git a/mfem-policy-compatibility.md b/mfem-policy-compatibility.md index 1592df6..4ad4ec9 100644 --- a/mfem-policy-compatibility.md +++ b/mfem-policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for MFEM -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [PETSc version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/petsc-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://www.mfem.org +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +52,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| In GNU make build system (which is also used by Spack) library dependencies are exported in a file `config.mk`. In the CMake build system, this information is exported, in the standard CMake fashon, in a file `MFEMConfig.cmake`.| |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial| Supported packages with required versions are documented in the `INSTALL` file in the MFEM repository/distribution. Most of this dependency information is also expressed in the MFEM Spack package.| |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full| All required files are present, except `SUPPORT`, the required contact information is in `CONTRIBUTING.md` and on https://mfem.org.| -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| https://mfem.org | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| https://mfem.org | diff --git a/omega-h-policy-compatibility.md b/omega-h-policy-compatibility.md index e7974c0..6e18473 100644 --- a/omega-h-policy-compatibility.md +++ b/omega-h-policy-compatibility.md @@ -1,10 +1,12 @@ # xSDK Community Policy Compatibility for Omega_h -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. **Website:** https://github.com/sandialabs/omega_h +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -37,4 +39,4 @@ and should be considered when filling out this form. |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Omega_h's build system exports such text files. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. | Partial | For packages in Spack, this is documented in the Spack package file. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Partial | We have README and LICENSE. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Partial| There are usage examples but no developer docs. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Partial| There are usage examples but no developer docs. | diff --git a/petsc-policy-compatibility.md b/petsc-policy-compatibility.md index 6e29f3f..4266052 100644 --- a/petsc-policy-compatibility.md +++ b/petsc-policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for PETSc -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [PETSc version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/petsc-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://petsc.org/release +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +52,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| The command make getlinklibs lists all dependencies for an install; PETSc 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 - which checks for compatilbe versions of packages as needed | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full| . Provides [README](https://gitlab.com/petsc/petsc/-/blob/main/README.md), [CONTRIBUTING](https://gitlab.com/petsc/petsc/-/blob/main/CONTRIBUTING), [LICENSE](https://gitlab.com/petsc/petsc/-/blob/main/LICENSE), [CODE_OF_CONDUCT](https://gitlab.com/petsc/petsc/-/blob/main/CODE_OF_CONDUCT.md) in repo and [CHANGES](https://petsc.org/release/docs/changes) | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| [Developer document](https://petsc.org/release/developers/) | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| [Developer document](https://petsc.org/release/developers/) | diff --git a/phist-policy-compatibility.md b/phist-policy-compatibility.md index c818358..990bc69 100644 --- a/phist-policy-compatibility.md +++ b/phist-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for PHIST -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://bitbucket.org/essex/phist +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -47,4 +51,4 @@ M2 details : There is an extensive suite of unit and inte |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| installs phistLibraries.cmake and a pkg-config file phist.pc, and provides an API call (cf. phist_tools.h)| |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial| Only available in CMake files and via spack. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. | Partial |SUPPORT file is missing (information available in README.md) | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| None. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| None. | diff --git a/plasma-policy-compatibility.md b/plasma-policy-compatibility.md index e8db535..7340760 100644 --- a/plasma-policy-compatibility.md +++ b/plasma-policy-compatibility.md @@ -1,7 +1,7 @@ # xSDK Community Policy Compatibility for PLASMA In this document, we summarize the continuing efforts of the current and future -xSDK member packages to achieve compatibility with the xSDK community policies. +xSDK packages to achieve compatibility with the xSDK community policies. What is available below is only a short description of each item of the policy. The full description is available as an [online document](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) @@ -13,12 +13,16 @@ their are applicable or have been implemented. If the package is not compatible, it is stated what is lacking and what are the specific plans on how to achieve compliance. -For current xSDK member packages: non-compliance at some point in time should +For current xSDK packages: non-compliance at some point in time should be described and the steps that were undertaken to fulfill the policy. This -information should be helpful for future xSDK member packages. +information should be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [PLASMA website on Bitbucket](https://github.com/icl-utk-edu/plasma) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -51,4 +55,4 @@ information should be helpful for future xSDK member packages. |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| New PLASMA release exports configuration details as a header file that is generated during configuration stage and through CMake's installation process. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| PLASMA depends on number of compiler and library features that are documented through CMake and Spack.| |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| PLASMA has `README.md`, `LICENCE`, and `ChangeLog` files in top directory, support contacts are in `README.md` | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| The majority of PLASMA's public and private functions are extensively documented through Doxygen and the development process uses the common Git flow model that is documented on external sites. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| The majority of PLASMA's public and private functions are extensively documented through Doxygen and the development process uses the common Git flow model that is documented on external sites. | diff --git a/precice-policy-compatibility.md b/precice-policy-compatibility.md index 57cfb7d..0d30ed3 100644 --- a/precice-policy-compatibility.md +++ b/precice-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for preCICE -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** http://precice.org +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -42,4 +46,4 @@ For current xSDK member packages: If you were not fully compatible at some point |**R5.** Provide a mechanism to export ordered list of library dependencies. |None| | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Spack can be used to generate this graph. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| Work in Progress | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |None| preCICE provides an extensive user documentation [precice.org/docs](https://precice.org/docs). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |None| preCICE provides an extensive user documentation [precice.org/docs](https://precice.org/docs). | diff --git a/pumi-policy-compatability.md b/pumi-policy-compatability.md index dab8276..dd5e9e0 100644 --- a/pumi-policy-compatability.md +++ b/pumi-policy-compatability.md @@ -1,10 +1,12 @@ # xSDK Community Policy Compatibility for PUMI, the Parallel Unstructured Mesh Infrastructure -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. **Website:** https://github.com/SCOREC/core/wiki +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +50,4 @@ Following the numbering in [Version 0.6.0 of the xSDK Spack Variant Guidelines]( |**R5.** Provide a mechanism to export ordered list of library dependencies. |partial| We provide a CMake package for other users of CMake; [example](https://github.com/SCOREC/core/blob/master/doc/user_CMakeLists.cmake). | |**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. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Partial| We provide a [developer guide](https://github.com/SCOREC/core/wiki/Developer-Guide). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Partial| We provide a [developer guide](https://github.com/SCOREC/core/wiki/Developer-Guide). | diff --git a/slate-policy-compatibility.md b/slate-policy-compatibility.md index 22a4529..844063a 100644 --- a/slate-policy-compatibility.md +++ b/slate-policy-compatibility.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for SLATE -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [PETSc version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/petsc-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** [http://icl.utk.edu/slate/](http://icl.utk.edu/slate/) +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -48,4 +52,4 @@ M2 details : optional: provide more details about approac |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| Exports dependencies via CMake. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Full| Via Spack. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| Has README.md, LICENSE, CHANGELOG.md. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| [User Guide](https://www.icl.utk.edu/publications/swan-010), [Dev Guide](https://www.icl.utk.edu/publications/swan-011), [Online docs](https://github.com/icl-utk-edu/slate#documentation). | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| [User Guide](https://www.icl.utk.edu/publications/swan-010), [Dev Guide](https://www.icl.utk.edu/publications/swan-011), [Online docs](https://github.com/icl-utk-edu/slate#documentation). | diff --git a/slepc-policy-compatibility.md b/slepc-policy-compatibility.md index 694ba9f..c943f28 100644 --- a/slepc-policy-compatibility.md +++ b/slepc-policy-compatibility.md @@ -1,15 +1,19 @@ # xSDK Community Policy Compatibility for SLEPc -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** http://slepc.upv.es +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -46,4 +50,4 @@ M2 details : optional: provide more details about approac |**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](https://gitlab.com/slepc/slepc/-/blob/main/README.md), [CONTRIBUTING](https://gitlab.com/slepc/slepc/-/blob/main/CONTRIBUTING.md), [LICENSE](https://gitlab.com/slepc/slepc/-/blob/main/LICENSE.md), and [CHANGELOG](https://gitlab.com/slepc/slepc/-/blob/main/CHANGELOG.md) 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.| +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Partial| Documentation currently supports use only, there is no documentation for developers.| diff --git a/strumpack-policy-compatibility.md b/strumpack-policy-compatibility.md index 52e50e1..a02a9fc 100644 --- a/strumpack-policy-compatibility.md +++ b/strumpack-policy-compatibility.md @@ -1,12 +1,16 @@ # xSDK Community Policy Compatibility for STRUMPACK -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) 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 compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages. +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 packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** http://portal.nersc.gov/project/sparse/strumpack/ +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -45,4 +49,4 @@ All STRUMPACK features are configurable through spack variants, including CUDA a |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| STRUMPACK exports a CMake config file which details library dependencies. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial| The STRUMPACK documentation has some information. Version conflicts are also part of the spack installation script. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| STRUMPACK has a README and LICENSE file. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| STRUMPACK has extensive user documentation with examples. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| STRUMPACK has extensive user documentation with examples. | diff --git a/sundials-policy-compatibility.md b/sundials-policy-compatibility.md index 88ab3d1..95a5ca5 100644 --- a/sundials-policy-compatibility.md +++ b/sundials-policy-compatibility.md @@ -1,14 +1,18 @@ # xSDK Community Policy Compatibility for SUNDIALS -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](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) 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 compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy. This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://computing.llnl.gov/projects/sundials +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -45,4 +49,4 @@ All SUNDIALS features are configurable through spack variants, including CUDA an |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| SUNDIALS exports a CMake config file which details library dependencies. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |Partial| The SUNDIALS user guides document versions of dependencies it works with. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Partial| SUNDIALS has a README.md, CHANGELOG.md and LICENSE file. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Full| SUNDIALS has extensive user documentation with examples. Developer documentation is internal only.| +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| SUNDIALS has extensive user documentation with examples. Developer documentation is internal only.| diff --git a/superlu-policy-compatibility.md b/superlu-policy-compatibility.md index 97d3c32..0388bcf 100644 --- a/superlu-policy-compatibility.md +++ b/superlu-policy-compatibility.md @@ -1,14 +1,18 @@ # xSDK Community Policy Compatibility for SuperLU -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) and should be considered when filling out this form. Please, provide information on your compability 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 compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://portal.nersc.gov/project/sparse/superlu/ +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | diff --git a/tasmanian-policy-compatibility.md b/tasmanian-policy-compatibility.md index 9cbe14f..bd5d363 100644 --- a/tasmanian-policy-compatibility.md +++ b/tasmanian-policy-compatibility.md @@ -1,14 +1,18 @@ # xSDK Community Policy Compatibility for Tasmanian -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) 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 compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://tasmanian.ornl.gov/ +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | diff --git a/template.md b/template.md index 63be8c8..7872b83 100644 --- a/template.md +++ b/template.md @@ -1,6 +1,6 @@ # xSDK Community Policy Compatibility for \ -This document summarizes the efforts of current and future xSDK member packages to achieve compatibility with the xSDK community policies version 1.0.0. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies version 1.0.0. Below only short descriptions of each policy are provided. The full description is available [here](https://github.com/xsdk-project/xsdk-community-policies) and should be considered when filling out this form. *** A good example of how to complete this form can be found in the [hypre version](https://github.com/xsdk-project/xsdk-policy-compatibility/blob/master/hypre-policy-compatibility.md). @@ -8,10 +8,14 @@ and should be considered when filling out this form. Please, provide information on your compability 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. +For current xSDK 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 packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** \ +**Member:** \ + ### Mandatory Policies | Policy |Support| Notes | @@ -32,7 +36,7 @@ For current xSDK member packages: If you were not fully compatible at some point |**M14.** Be buildable using 64 bit pointers. 32 bit is optional. |Full/Partial/None| Package supports both 32 and 64 bit under same API. | |**M15.** All xSDK compatibility changes should be sustainable. |Full/Partial/None| None. | |**M16.** Have a debug build option. |Full/Partial/None| None. | -|**M17.** Each xSDK member package should have sufficient documentation to support use and further development. |Full/Partial/None| While documentation for users is mandatory, developer documentation is recommended, but not yet required. | +|**M17.** Each xSDK package should have sufficient documentation to support use and further development. |Full/Partial/None| While documentation for users is mandatory, developer documentation is recommended, but not yet required. | M1 details : optional: provide more details about approach to addressing topic M1. diff --git a/trillinos-policy-compatibility.md b/trillinos-policy-compatibility.md index 9c055c0..3927034 100644 --- a/trillinos-policy-compatibility.md +++ b/trillinos-policy-compatibility.md @@ -1,14 +1,18 @@ # xSDK Community Policy Compatibility for Trilinos -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](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) +This document summarizes the efforts of current and future xSDK packages to achieve compatibility with the xSDK community policies. Below only short descriptions of each policy are provided. The full description is available [here](https://docs.google.com/document/d/1DCx2Duijb0COESCuxwEEK1j0BPe2cTIJ-AjtJxt3290/edit#heading=h.2hp5zbf0n3o3) 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 compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK member packages. +For current xSDK packages: If you were not compliant at some point, please describe the steps you undertook to fulfill the policy.This information will be helpful for future xSDK packages. + +An xSDK compatible package is considered to be a member package if it uses, or can be used by another package in the xSDK. **Website:** https://trilinos.github.io +**Member:** yes + ### Mandatory Policies | Policy |Support| Notes | @@ -41,4 +45,4 @@ For current xSDK member packages: If you were not compliant at some point, pleas |**R5.** Provide a mechanism to export ordered list of library dependencies. |Full| TriBITS takes care of this both with CMake's FIND_PACKAGE and for Makefule users. | |**R6.** Document versions of packages that it works with or depends upon, preferably in machine-readable form. |None| None. | |**R7.** Have README, SUPPORT, LICENSE, and CHANGELOG files in top directory. |Full| None. | -|**R8.** Each xSDK member package should have sufficient documentation to support use and further development. |Partial| There is full documentation for usage as well as example codes, there is an old developer manual, which needs to be updated or completely replaced. | +|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Partial| There is full documentation for usage as well as example codes, there is an old developer manual, which needs to be updated or completely replaced. |