README.rst 3.35 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2
.. vim: set fileencoding=utf-8 :

3
.. Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/          ..
André Anjos's avatar
André Anjos committed
4 5
.. Contact: beat.support@idiap.ch                                             ..
..                                                                            ..
6
.. This file is part of the beat.backend.python module of the BEAT platform.  ..
André Anjos's avatar
André Anjos committed
7
..                                                                            ..
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
.. Redistribution and use in source and binary forms, with or without
.. modification, are permitted provided that the following conditions are met:

.. 1. Redistributions of source code must retain the above copyright notice, this
.. list of conditions and the following disclaimer.

.. 2. Redistributions in binary form must reproduce the above copyright notice,
.. this list of conditions and the following disclaimer in the documentation
.. and/or other materials provided with the distribution.

.. 3. Neither the name of the copyright holder nor the names of its contributors
.. may be used to endorse or promote products derived from this software without
.. specific prior written permission.

.. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
.. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
.. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
.. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
.. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

André Anjos's avatar
André Anjos committed
33

34
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
35 36 37
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.core/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.core/master/index.html
38 39 40 41
.. image:: https://gitlab.idiap.ch/beat/beat.core/badges/master/build.svg
   :target: https://gitlab.idiap.ch/beat/beat.core/commits/master
.. image:: https://gitlab.idiap.ch/beat/beat.core/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/beat/beat.core/commits/master
42 43 44 45
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/beat/beat.core
.. image:: https://img.shields.io/pypi/v/beat.core.svg
   :target: https://pypi.python.org/pypi/beat.core
André Anjos's avatar
André Anjos committed
46 47


48 49 50 51 52 53
==========================
 Core Components for BEAT
==========================

This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains the source code for its core components.
André Anjos's avatar
André Anjos committed
54

André Anjos's avatar
André Anjos committed
55

André Anjos's avatar
André Anjos committed
56 57 58
Installation
------------

59 60
Complete BEAT's `installation`_ instructions. Then, to install this package,
run::
André Anjos's avatar
André Anjos committed
61

André Anjos's avatar
André Anjos committed
62
  $ conda install beat.core
André Anjos's avatar
André Anjos committed
63 64


65
Contact
André Anjos's avatar
André Anjos committed
66 67
-------

68 69
For questions or reporting issues to this software package, contact our
development `mailing list`_.
André Anjos's avatar
André Anjos committed
70 71


72 73 74 75
.. 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