From 66b873786b2a9afff24d5cb2f8dac4f679a75be6 Mon Sep 17 00:00:00 2001 From: Alejandra Gonzalez-Beltran Date: Thu, 2 Mar 2017 16:01:44 +0000 Subject: [PATCH] Added documentation on running the tests. --- docs/installation.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index 65e977e6..31f15d76 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -46,3 +46,18 @@ if you want to upgrade the requirements already installed. Now you're ready to get started! For full instructions on installing and using ``virtualenv`` see `their documentation `_. + +Running tests +------------- + +The tests in the ISA-API rely on datasets available in the test branch of the `ISAdatasets repository `_. + +Thus, the first step for running the tests is to clone that branch under the /tests/data folder: + +``git clone -b tests --single-branch http://github.com/ISA-tools/ISAdatasets tests/data`` + +After that, you can run the test with the usual command: + +``python setup.py test`` + +