Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to the README file in the 'test' directory #609

Merged
merged 2 commits into from
Nov 5, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 1 addition & 63 deletions test/README
Original file line number Diff line number Diff line change
Expand Up @@ -5,66 +5,4 @@ PyNN testing is divided into several different types of test:
* running the example scripts
* doctests


NOTE: the test suite is currently being reorganised to work with nose (http://somethingaboutorange.com/mrl/projects/nose),
in order to facilitate continuous integration testing.

Many of the scripts listed below have been temporarily moved to an `unsorted` directory, until they can be
integrated into the nose framework.



API syntax consistency
----------------------

checkAPI.py


Unit tests
----------

In the `unittests` subdirectory. Tests can be run individually, or all at once
with coverage measurement using `alltests.sh`.

Note that the `generictests.py` script takes the simulator backend as a
command-line argument.

`generictests.py` should be run both with "python" and with "mpirun python".


Regression tests
----------------

Any time there is a bug/defect on the tracker, appropriate tests should be added to both
the `unittests` and `system` directories.


System tests
------------

These tests compare the output of different simulators for the same script. Each
test can be run directly by providing a parameter file on the command line,
e.g.:

python test_synaptic_integration.py parameters/test_synaptic_integration.param neuron nest

or it can be run with many different parameter sets using the explore_space.py
script, e.g.:

python explore_space.py -n 5 -f ~/mpd.hosts test_synaptic_integration.py parameters/test_synaptic_integration.space neuron nest




Running the example scripts
---------------------------

test_examples.py
test_examples_mpi.py


Documentation tests
-------------------

Tests that the code examples given in the documentation are correct.
XXXX
For full documentation on testing, see:http://neuralensemble.org/docs/PyNN/developers/contributing.html#testing