Skip to content
Snippets Groups Projects
Commit 158c80a3 authored by Christoph Groth's avatar Christoph Groth
Browse files

advertise kwant.test() in README

parent 9a1507f9
No related branches found
No related tags found
No related merge requests found
......@@ -24,12 +24,15 @@ The following software is highly recommended though not strictly required:
footprint. (kwant uses only the sequential, single core version
of MUMPS. The advantages due to MUMPS as used by kwant are thus independent
of the number of CPU cores of the machine on which kwant runs.)
* The `nose <http://nose.readthedocs.org/>`_ testing framework for running the
tests included with kwant.
In addition, to build a copy of kwant that has been checked-out directly from
version control (git), you will also need `Cython <http://cython.org/>`_ 0.17.1
or newer. You do not need Cython to build kwant that has been unpacked from a
source .tar.gz-file.
Generic instructions
====================
......@@ -45,11 +48,9 @@ in the root directory of the kwant distribution. ::
Depending on your system, you might have to run the second command with
administrator privileges (e.g. prefixing it with ``sudo``).
To check successful installation try executing some scripts in the ``tutorial``
subdirectory, e.g.::
After installation, tests can be run with::
cd tutorial
python 1-quantum_wire_revisited.py
python -c 'import kwant; kwant.test()'
System-specific instructions
......@@ -66,7 +67,8 @@ or newer. For other systems step 1 will likely have to be adapted. If
1. Install the required packages by running the command ::
sudo apt-get install python-dev python-scipy python-matplotlib \
g++ gfortran libopenblas-dev liblapack-dev libmumps-scotch-dev
python-nose g++ gfortran libopenblas-dev liblapack-dev \
libmumps-scotch-dev
2. Unpack tinyarray, enter its directory. To build and install, run ::
......@@ -263,8 +265,3 @@ Some conventions to keep in mind:
Several modules are written in `Cython <http://cython.org/>`_ (.pyx file name
extension). You will need Cython if you want to modify them.
kwant includes extensive unit tests which are supposed to cover all of its
functionality. We use the `nose <http://nose.readthedocs.org/>`_ testing
framework. To run the tests, execute the command ``nosetests`` from the root
directory of the package after it has been built in place.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment