.. 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.backend.python 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/.          ..

.. image:: https://img.shields.io/badge/docs-v1.5.1-yellow.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/master/index.html
.. image:: https://gitlab.idiap.ch/beat/beat.backend.python/badges/v1.5.1/build.svg
   :target: https://gitlab.idiap.ch/beat/beat.backend.python/commits/v1.5.1
.. image:: https://gitlab.idiap.ch/beat/beat.backend.python/badges/v1.5.1/coverage.svg
   :target: https://gitlab.idiap.ch/beat/beat.backend.python/commits/v1.5.1
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/beat/beat.backend.python
.. image:: https://img.shields.io/pypi/v/beat.backend.python.svg
   :target: https://pypi.python.org/pypi/beat.backend.python


=========================
 Python Backend for BEAT
=========================

This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains the minimum amount of code needed to run
user algorithms or inject data in toolchains from locally installed raw data
assets.

The `User Guide`_ provides installation and usage instructions.

Installation
------------

Complete BEAT's `installation`_ instructions. Then, to install this package,
run::

  $ conda install beat.backend.python


Contact
-------

For questions or reporting issues to this software package, contact our
development `mailing list`_.


.. 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
.. _user guide: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/master/index.html