README.rst 3.01 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
.. 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.web 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/.          ..


André Anjos's avatar
André Anjos committed
24
.. image:: https://img.shields.io/badge/docs-available-orange.svg
25
   :target: https://www.idiap.ch/software/beat/docs/beat/beat.web/master/index.html
26 27 28 29
.. image:: https://gitlab.idiap.ch/beat/beat.web/badges/v2.2.3/pipeline.svg
   :target: https://gitlab.idiap.ch/beat/beat.web/commits/v2.2.3
.. image:: https://gitlab.idiap.ch/beat/beat.web/badges/v2.2.3/coverage.svg
   :target: https://gitlab.idiap.ch/beat/beat.web/commits/v2.2.3
30 31
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/beat/beat.web
André Anjos's avatar
André Anjos committed
32

33 34 35 36 37 38 39 40

===================
 BEAT Web Platform
===================

This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows.  It contains source code for the online platform of
BEAT.
André Anjos's avatar
André Anjos committed
41 42 43 44 45


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

46 47
Start by downloading and installing miniconda_.  Then, to install this package,
run::
André Anjos's avatar
André Anjos committed
48

49 50 51
  $ conda env create -f dev.yml
  $ conda activate beat-web
  $ buildout
52
  $ ./scripts/docker_pull.sh master
André Anjos's avatar
André Anjos committed
53

54
These commands should download and install all non-installed dependencies and
André Anjos's avatar
André Anjos committed
55 56 57
get you a fully operational test and development environment.


58 59
Contact
-------
André Anjos's avatar
André Anjos committed
60

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

André Anjos's avatar
André Anjos committed
64

65 66 67 68 69
.. 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
.. _miniconda: https://conda.io/miniconda.html