This document summarizes the efforts of current and future BAND member packages to achieve compatibility with the BAND SDK community policies. Additional details on the BAND SDK are available here and should be considered when filling out this form. The most recent copy of this template exists here.
This file should filled out and placed in the directory in the
bandframeworkrepository representing the software name appended bybandsdk. For example, if you have a softwarefoo, the compatibility file should be namedfoobandsdk.mdand placed in the directory housing the software in thebandframeworkrepository. No open source code can be included without this file.All code included in this repository will be open source. If a piece of code does not contain a open-source LICENSE file as mentioned in the requirements below, then it will be automatically licensed as described in the LICENSE file in the root directory of the bandframework repository.
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 BAND SDK 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 BAND member packages.
To suggest changes to these requirements or obtain more information, please contact BAND.
Details on citing the current version of the BAND Framework can be found in the README.
Website: <package website>
Contact: <contact information>
Icon: <url of icon you would like to display>
Description: <a short description of the code> \
BAND SDK
| # | Policy | Support | Notes |
|---|---|---|---|
| 1. | Support BAND community GNU Autoconf, CMake, or other build options. | Full | Short-explanation-here; optional link for more extensive details if needed, see below. M1 details |
| 2. | Have a README file in the top directory that states a specific set of testing procedures for a user to verify the software was installed and run correctly. | Full | None. M2 details |
| 3. | Provide a documented, reliable way to contact the development team. | Full | None. |
| 4. | Come with an open-source license. | Full | Uses 2-clause BSD license. |
| 5. | Provide a runtime API to return the current version number of the software. | Full | None. |
| 6. | Provide a BAND team-accessible repository. | Full | None. |
| 7. | Must allow installing, building, and linking against an outside copy of all imported software that is externally developed and maintained. | Full | None. |
| 8. | Have no hardwired print or IO statements that cannot be turned off. | Full | None. |
M1 details : optional: provide more details about approach to addressing topic M1.
M2 details : optional: provide more details about approach to addressing topic M2.
| # | Policy | Support | Notes |
|---|---|---|---|
| R1. | Have a public repository. | Partial | Repo is access controlled but available as release tarfile. |
| R2. | Free all system resources acquired as soon as they are no longer needed. | Full | None. |
| R3. | Provide a mechanism to export ordered list of library dependencies. | None | None. |
| R4. | Document versions of packages that it works with or depends upon, preferably in machine-readable form. | None | None. |
| R5. | Have SUPPORT, LICENSE, and CHANGELOG files in top directory. | None | None. |
| R6. | Have sufficient documentation to support use and further development. | None | None. |
| R7. | Be buildable using 64-bit pointers; 32-bit is optional. | Full | Package supports both 32 and 64 bit under same API. |
| R8. | Do not assume a full MPI communicator; allow for user-provided MPI communicator. | N/a | None. |
| R9. | Use a limited and well-defined name space (e.g., symbol, macro, library, include). | Full | None. |
| R10. | Give best effort at portability to key architectures. | Full | None. |
| R11. | Install headers and libraries under <prefix>/include and <prefix>/lib, respectively. |
Full | None. |
| R12. | All BAND compatibility changes should be sustainable. | Full | None. |
| R13. | Respect system resources and settings made by other previously called packages. | Full | None. |
| R14. | Provide a comprehensive test suite for correctness of installation verification. | Full | None. |