If you have gotten 'qmachine' from source, you may run the tests locally.
Install qmachine
along with its test dependencies into your virtual environment by executing the following in the root folder
$ pip install .
$ pip install -r test_requirements.txt
Then run pytest
in the tests
folder.
If you have gotten qmachine
from source, you may build the docs locally.
Install qmachine
along with its documentation dependencies into your virtual environment by executing the following in the root folder
$ pip install .
$ pip install -r docs_requirements.txt
You also need to install pandoc
. If you are using conda
, that can be achieved by
$ conda install pandoc
else, see here for pandoc's installation instructions.
Then run make html
in the docs
folder. The next time you build the documentation, remember to run make clean
before you run make html
.