Commit ead218f9 authored by André Anjos's avatar André Anjos 💬

Update README

parent 6a200923
......@@ -3,7 +3,7 @@
.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ ..
.. Contact: beat.support@idiap.ch ..
.. ..
.. This file is part of the beat.cmdline module of the BEAT platform. ..
.. This file is part of the beat.cmdline module of the BEAT platform. ..
.. ..
.. Commercial License Usage ..
.. Licensees holding valid commercial BEAT licenses may use this file in ..
......@@ -20,123 +20,47 @@
.. 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/. ..
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.cmdline/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.cmdline/master/index.html
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/master/build.svg
:target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/master
.. image:: https://gitlab.idiap.ch/beat/beat.cmdline/badges/master/coverage.svg
:target: https://gitlab.idiap.ch/beat/beat.cmdline/commits/master
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
:target: https://gitlab.idiap.ch/beat/beat.cmdline
.. image:: https://img.shields.io/pypi/v/beat.cmdline.svg
:target: https://pypi.python.org/pypi/beat.cmdline
============================================
Biometrics Evaluation and Testing Platform
============================================
This package contains the source code for a python-based command-line client
for the BEAT platform.
==========================
Core Components for BEAT
==========================
Dependence Status
-----------------
This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains the command-line based program that can
download/upload components with the platform. It can also run experiments
locally.
Before checking-out sources, make sure of the project health as per table
below:
.. |beat.cmdline-status| image:: https://gitlab.idiap.ch/ci/projects/5/status.png?ref=master
:target: https://gitlab.idiap.ch/ci/projects/5?ref=master
.. |beat.core-status| image:: https://gitlab.idiap.ch/ci/projects/2/status.png?ref=master
:target: https://gitlab.idiap.ch/ci/projects/2?ref=master
============================= ========================
Package Status (master branch)
============================= ========================
beat.core |beat.core-status|
beat.cmdline (this package) |beat.cmdline-status|
============================= ========================
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/environments/staging/usr/bin/python`` to bootstrap this
package instead. It contains the same setup deployed at the final BEAT
machinery.
Complete BEAT's `installation`_ instructions. Then, to install this package,
run::
$ conda install beat.cmdline
Documentation
-------------
To build the documentation, just do::
$ ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat beat/cmdline/test beat/cmdline/scripts
$ ./bin/sphinx-build doc sphinx
Testing
Contact
-------
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_CMDLINE_TEST_PLATFORM`` to point to that address. For
example::
$ export BEAT_CMDLINE_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.cmdline
To produce an HTML test coverage report, at the directory `./htmlcov`, do the
following::
$ ./bin/nosetests -sv --with-coverage --cover-package=beat.cmdline --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
-----------
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::
For questions or reporting issues to this software package, contact our
development `mailing list`_.
$ ./bin/python -mpstats prof.data
This will allow you to dump and print the profiling statistics as you may find
fit.
.. Place your references here:
.. _beat: https://www.idiap.ch/software/beat
.. _installation: https://www.idiap.ch/software/beat/install
.. _mailing list: https://www.idiap.ch/software/beat/discuss
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment