Note about tests.

pfizer-opensource · Sep 26, 2024 · 5ac9f0d · 5ac9f0d
1 parent c543fce
commit 5ac9f0d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -172,6 +172,18 @@ anything is unclear, please open an issue.
 4. `pip install -e '.[dev]'`
 5. run `pre-commit install` to install the pre-commit hooks
 
+### Run Tests
+Tests are in the tests directory. One of the most important tests is
+test_against_pybigwig which makes sure that if there is a mistake in
+pyBigWIg, it is also in bigwig-loader.
+
+```shell
+pytest -vv .
+```
+
+When github runners with GPU's will become available we would also
+like to run these tests in the CI. But for now, you can run them locally.
+
 
 ## Citing