Create README.md for tests

scienxlab · Sep 27, 2023 · 003596a · 003596a
1 parent c74ebcd
commit 003596a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,9 @@
+## Tests
+
+Note that most of the tests in `redflag` are doctests. The testing code is in the docstrings of the various functions, under the 'examples' heading.
+
+The Jupyter Notebooks in `docs/notebooks` are also run as part of the tests.
+
+To run the tests: clone the repo, install the dev dependencies (e.g. with `pip install .[dev]`) and do:
+
+    pytest