Skip to content

Commit fd84b9e

Browse files
committed
Added a testing guide to the installation readme
1 parent d8fc4ea commit fd84b9e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,15 @@ Before building the modules in this repository, you will need to make sure that
4949
```
5050
* Pipenv ([see this link](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv))
5151
* Redis Server (`redis-server`)
52+
53+
## Testing ##
54+
55+
### Manual Method ###
56+
57+
1. Install the following additional packages: `pip install scipy pytest flaky`
58+
2. Navigate to the build directory `cd build`
59+
3. Run `pytest`
60+
61+
### Automatic Method ###
62+
63+
1. Run the included `install_and_test.sh` script, which will create a temporary virtual environment and run the tests within it.

0 commit comments

Comments
 (0)