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

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.. 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.         ..
..                                                                            ..
.. 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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53


========================
BEAT Command-line Client
========================

.. _beat-cmdline-introduction:

This package implements a Python-based client for BEAT's web service or locally
installed repositories. It allows users to list, validate, edit, download and
upload objects from remote BEAT instances. It dubs as a Python-client API for
packages required to implement more advanced functionality than already
available on the currently avaiable tool, called `beat`, as we shall see next.

.. toctree::

    introduction
    configuration
    dataformats
    algorithms
    libraries
    toolchains
    experiments
    databases
    api/beat.cmdline

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`