Skip to content

Commit

Permalink
Update install_developers.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mavaylon1 authored Mar 6, 2024
1 parent 9f502ed commit 579b1a4
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/source/install_developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,19 @@ editable mode.
Run tests
---------

You can run the full test suite by running:
For running the tests, it is required to install the development requirements. Again, first activate your
virtualenv or conda environment.

.. code:: bash
pytest
.. code::
$ git clone --recurse-submodules https://github.com/NeurodataWithoutBorders/pynwb.git
$ cd pynwb
$ pip install -r requirements.txt -r requirements-dev.txt
$ pip install -e .
$ tox
This will run all the tests and compute the test coverage. The coverage report can be found in ``/htmlcov``.
For debugging it can be useful to keep the intermediate NWB files created by
the tests. To keep these files create the environment variables
``CLEAN_NWB``/``CLEAN_HDMF`` and set them to ``1``.


FAQ
Expand Down

0 comments on commit 579b1a4

Please sign in to comment.