Skip to content

Commit b714edb

Browse files
mosesyhcmosesyhc
authored
Merge pull request #184 from bandframework/sdkupdate
Clarify test procedures in surmise BAND SDK
2 parents 5f43b19 + 96aec9a commit b714edb

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

‎surmisebandsdk.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@
2727

2828
**BAND SDK**
2929

30-
| # | Policy |Support| Notes |
31-
|---|-----------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
32-
| 1. | Support BAND community GNU Autoconf, CMake, or other build options |Full| surmise is a Python package and provides a `pyproject.toml`-`setup.py` file for installation. This is compatible with the pip installer. Additional build instructions can be found under README. GNU Autoconf or CMake are unsuitable for a Python package. |
33-
| 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| README explains full test procedure. |
34-
| 3. | Provide a documented, reliable way to contact the development team |Full| The surmise team can be contacted through the public [issues page on GitHub](https://github.com/bandframework/surmise/issues) or via an e-mail to [the surmise team](SUPPORT.rst). |
35-
| 4. | Come with an open-source license |Full| surmise uses the MIT license. [M4 details](#m4-details) |
36-
| 5. | Provide a runtime API to return the current version number of the software |Full| The version can be returned within Python via: `surmise.__version__`. |
37-
| 6. | Provide a BAND team-accessible repository |Full| https://github.com/bandframework/surmise |
30+
| # | Policy |Support| Notes |
31+
|---|-----------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
32+
| 1. | Support BAND community GNU Autoconf, CMake, or other build options |Full| surmise is a Python package and provides a `pyproject.toml`-`setup.py` file for installation. This is compatible with the pip installer. Additional build instructions can be found under README. GNU Autoconf or CMake are unsuitable for a Python package. |
33+
| 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| The test procedures can be run via `surmise.test()`, included in the README. |
34+
| 3. | Provide a documented, reliable way to contact the development team |Full| The surmise team can be contacted through the public [issues page on GitHub](https://github.com/bandframework/surmise/issues) or via an e-mail to [the surmise team](SUPPORT.rst). |
35+
| 4. | Come with an open-source license |Full| surmise uses the MIT license. [M4 details](#m4-details) |
36+
| 5. | Provide a runtime API to return the current version number of the software |Full| The version can be returned within Python via: `surmise.__version__`. |
37+
| 6. | Provide a BAND team-accessible repository |Full| https://github.com/bandframework/surmise |
3838
| 7. | Must allow installing, building, and linking against an outside copy of all imported software that is externally developed and maintained |Full| surmise does not contain any other package's source code within. Note that Python packages are imported using the conventional `sys.path` system. Alternative instances of a package can be used, for example, by including them through an appropriate definition of the PYTHONPATH environment variable. |
39-
| 8. | Have no hardwired print or IO statements that cannot be turned off |Full| There are no mandatory print statements: any print statements for code feedback in a method can be suppressed via `verbose` argument. |
39+
| 8. | Have no hardwired print or IO statements that cannot be turned off |Full| There are no mandatory print statements: any print statements for code feedback in a method can be suppressed via `verbose` argument. |
4040

4141
M4 details <a id="m4-details"></a>: This was chosen based on the MIT license being the default license for BAND.
4242

@@ -58,6 +58,5 @@ M4 details <a id="m4-details"></a>: This was chosen based on the MIT license bei
5858
|**R11.**| Install headers and libraries under `<prefix>/include` and `<prefix>/lib`, respectively |Full| The standard Python installation is used for Python dependencies. This installs external Python packages under `<install-prefix>/lib/python<X.Y>/site-packages/`. |
5959
|**R12.**| All BAND compatibility changes should be sustainable |Full| The BAND-compatible package is in the standard release path. All the changes here should be sustainable. |
6060
|**R13.**| Respect system resources and settings made by other previously called packages |Full| surmise does not modify system resources or settings. |
61-
|**R14.**| Provide a comprehensive test suite for correctness of installation verification |Full| surmise contains a comprehensive set of unit tests that can be run, individually or all at once, via pytest with a high coverage. Running ``python -m pytest`` under `tests/` directory performs comprehensive testing. [R14 details](#r14-details) |
61+
|**R14.**| Provide a comprehensive test suite for correctness of installation verification |Full| surmise contains a comprehensive set of unit tests that can be run via `surmise.test()` in a Python environment. The testing procedure is also included in the README. |
6262

63-
R14 details <a id="r14-details"></a>: See the `README.rst` file in the `tests` directory.

0 commit comments

Comments
 (0)