.. vim: set fileencoding=utf-8 : .. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ .. .. Contact: beat.support@idiap.ch .. .. .. .. This file is part of the beat.core module of the BEAT platform. .. .. .. .. Commercial License Usage .. .. Licensees holding valid commercial BEAT licenses may use this file in .. .. accordance with the terms contained in a written agreement between you .. .. and Idiap. For further information contact tto@idiap.ch .. .. .. .. Alternatively, this file may be used under the terms of the GNU Affero .. .. Public License version 3 as published by the Free Software and appearing .. .. in the file LICENSE.AGPL included in the packaging of this file. .. .. The BEAT platform is distributed in the hope that it will be useful, but .. .. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY .. .. or FITNESS FOR A PARTICULAR PURPOSE. .. .. .. .. You should have received a copy of the GNU Affero Public License along .. .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. ============================================ Biometrics Evaluation and Testing Platform ============================================ This package contains the source code for the core components of the BEAT platform. Installation ------------ Really easy, with ``zc.buildout``:: $ python bootstrap-buildout.py $ ./bin/buildout These 2 commands should download and install all non-installed dependencies and get you a fully operational test and development environment. .. note:: The python shell used in the first line of the previous command set determines the python interpreter that will be used for all scripts developed inside this package. If you are on the Idiap filesystem, you may use ``/idiap/project/beat/beat.env.deploy/usr/bin/python`` to bootstrap this package instead. It contains the same setup deployed at the final BEAT machinery. Cpulimit ======== Make sure the program ``cpulimit`` is available on your system or by the side of the python interpreter you bootstrapped as per instructions above. The BEAT platform uses this program to control slot usage on the scheduling/worker level:: $ cpulimit -h If that is not the case, then you need to install it. Either install a package that is native to your system (e.g. on Debian or Ubuntu platforms) or compile the checked-out version available at ``src/cpulimit``:: $ cd src/cpulimit; $ make $ ./src/cpulimit -h #to test it $ cd ../../bin #go back to the root of beat.web and the into the `bin' dir $ ln -s ../src/cpulimit/src/cpulimit $ cd .. #go back to the root of beat.web Docker Setup ============ Make sure you have the ``docker`` command available on your system. For certain operating systems, it is necessary to install ``docker`` via an external virtual machine (a.k.a. the *docker machine*). Follow the instructions at `the docker website ` before trying to execute algorithms or experiments. We use specific docker images to run user algorithms. Download the following base images before you try to run tests or experiments on your computer:: $ docker pull beats/py27:system Optionally, also download the following images to be able to re-run experiments downloaded from the BEAT platform (not required for unit testing):: $ docker pull beats/py27:0.0.4 $ docker pull beats/py27:0.1.0 Documentation ------------- To build the documentation, just do:: $ ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat beat/core/test beat/core/scripts $ ./bin/sphinx-build doc sphinx Testing ------- After installation, it is possible to run our suite of unit tests. To do so, use ``nose``:: $ ./bin/nosetests -sv .. note:: Some of the tests for our command-line toolkit require a running BEAT platform web-server, with a compatible ``beat.core`` installed (preferably the same). By default, these tests will be skipped. If you want to run them, you must setup a development web server and set the environment variable ``BEAT_CORE_TEST_PLATFORM`` to point to that address. For example:: $ export BEAT_CORE_TEST_PLATFORM="http://example.com/platform/" $ ./bin/nosetests -sv It is **not** adviseable to run tests against a production web server. If you want to skip slow tests (at least those pulling stuff from our servers) or executing lengthy operations, just do:: $ ./bin/nosetests -sv -a '!slow' To measure the test coverage, do the following:: $ ./bin/nosetests -sv --with-coverage --cover-package=beat.core To produce an HTML test coverage report, at the directory `./htmlcov`, do the following:: $ ./bin/nosetests -sv --with-coverage --cover-package=beat.core --cover-html --cover-html-dir=htmlcov Our documentation is also interspersed with test units. You can run them using sphinx:: $ ./bin/sphinx -b doctest doc sphinx Development ----------- Indentation =========== You can enforce `PEP8 ` compliance using the application ``autopep8``. For example, to enforce compliance on a single file and edit it in place, do:: $ ./bin/autopep8 --indent-size=2 --in-place beat/core/utils.py We normally use 2-space identattion. If ever, you can easily change the identation to 4 spaces like this:: $ ./bin/autopep8 --indent-size=4 --in-place beat/core/utils.py Profiling ========= In order to profile the test code, try the following:: $ ./bin/python -mcProfile -oprof.data ./bin/nosetests -sv ... This will dump the profiling data at ``prof.data``. You can dump its contents in different ways using another command:: $ ./bin/python -mpstats prof.data This will allow you to dump and print the profiling statistics as you may find fit.