Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions amrex-policy-compatibility.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down Expand Up @@ -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. |
4 changes: 3 additions & 1 deletion arborx-policy-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**Website:** https://github.com/arborx/ArborX

**Member:** yes

### Mandatory Policies

| Policy |Support| Notes |
Expand Down Expand Up @@ -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 |
10 changes: 7 additions & 3 deletions blas++-policy-compatibility.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# 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).

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 |
Expand Down Expand Up @@ -48,4 +52,4 @@ M2 details <a id="m2-details"></a>: 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). |
10 changes: 7 additions & 3 deletions butterflypack-policy-compatibility.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down Expand Up @@ -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. |

4 changes: 3 additions & 1 deletion dealii-policy-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**Website:** https://www.dealii.org/

**Member:** yes

### Mandatory Policies

| Policy |Support| Notes |
Expand Down Expand Up @@ -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. |
|**R8.** Each xSDK package should have sufficient documentation to support use and further development. |Full| Extensive documentation of all aspects. |
4 changes: 3 additions & 1 deletion dtk-policy-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**Website:** https://github.com/ORNL-CEES/DataTransferKit

**Member:** yes

### Mandatory Policies

| Policy | Support | Notes |
Expand Down Expand Up @@ -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 |
8 changes: 6 additions & 2 deletions exago-policy-compatibility.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down Expand Up @@ -44,4 +48,4 @@ M2 details <a id="m2-details"></a>: 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. |
10 changes: 7 additions & 3 deletions fftx-policy-compatibility.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# 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).

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 |
Expand All @@ -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

Expand Down
Loading