From 003596a8f9b01d3b038ca86463716c95631eda44 Mon Sep 17 00:00:00 2001 From: Matt Hall Date: Wed, 27 Sep 2023 12:51:05 +0200 Subject: [PATCH] Create README.md for tests --- tests/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 tests/README.md diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..bb3750d --- /dev/null +++ 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