Commit 53abfb39 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[general][doc] some more rearrangement

parent 018c642f
Pipeline #24678 passed with stages
in 5 minutes and 41 seconds
......@@ -27,33 +27,7 @@
BEAT
======
The BEAT is a system for computing and certifying results for
software-based data-driven workflows that can be sub-divided functionally (into
processing blocks). The user provides the
description of data formats, algorithms, data flows (also known as toolchains)
and experimental details (parameters), which are used to
produce beautiful results, easily exportable into computer graphics or tables
for scientific reports.
The BEAT can be easily installed and used locally (see `beat editor`_). It can
also be used on a web based platform that lets the user leverage from the benefit
of higher computation power as well as interacting with other teams and projects.
The platform takes all burden of hosting data and software
away from users by providing a capable computing farm that handles both aspects
graciously. Data is kept sequestered inside the platform.
The BEAT is intended as a fundamental building-block in `Reproducible Research`_,
allowing academic and industrial parties to prescribe system behavior and have
it reproducible through software, hardware and staff generations. Here are some
known applications:
* Challenges and competitions on defined data, protocols and workflow
components;
* Study group exercises and exams;
* Support to publication submission;
* System and algorithm performance optimization;
* Reproduction of experiments through communities;
* Support for industry-academy relationship.
Let's start learning BEAT!
......
.. vim: set fileencoding=utf-8 :
===================================
Documentation of all BEAT packages
===================================
======
BEAT
======
Beat Packages
-------------
BEAT is a system for computing and certifying results for
software-based data-driven workflows that can be sub-divided functionally (into
processing blocks). The user provides the
description of data formats, algorithms, data flows (also known as toolchains)
and experimental details (parameters), which are used to
produce beautiful results, easily exportable into computer graphics or tables
for scientific reports.
BEAT can be easily installed and used locally (see :ref:`beat_editor`). It can
also be used on a web based platform that lets the user leverage from the benefit
of higher computation power as well as interacting with other teams and projects (see :ref:`beat_web_user`).
The platform takes all burden of hosting data and software
away from users by providing a capable computing farm that handles both aspects
graciously. Data is kept sequestered inside the platform.
The BEAT is intended as a fundamental building-block in `Reproducible Research`_,
allowing academic and industrial parties to prescribe system behavior and have
it reproducible through software, hardware and staff generations. Here are some
known applications:
* Challenges and competitions on defined data, protocols and workflow
components;
* Study group exercises and exams;
* Support to publication submission;
* System and algorithm performance optimization;
* Reproduction of experiments through communities;
* Support for industry-academy relationship.
Start here
==========
* :ref:`beat_general`
Documentation of all BEAT packages
==================================
* :ref:`beat_core`
* :ref:`beat_cmdline_introduction`
* :ref:`beat_backend_python`
......@@ -32,3 +65,5 @@ Index of all Packages
beat.web - api <beat.web/doc/api/index.rst>
beat.web - user <beat.web/doc/user/index.rst>
readme_index.rst
.. include:: links.rst
\ No newline at end of file
.. Place your links here
.. _beat: https://www.idiap.ch/software/beat
.. _docker: https://www.docker.com/
.. _reproducible research: https://reproducibleresearch.net/
.. _numpy safe-casting rules: http://docs.scipy.org/doc/numpy/reference/generated/numpy.can_cast.html
.. _zen of python: https://www.python.org/dev/peps/pep-0020/
.. _json: http://en.wikipedia.org/wiki/JSON
.. _beat.env.python27: http://gitlab.idiap.ch/biometric/beat.env.python27
.. _beat.backend.python: http://gitlab.idiap.ch/biometric/beat.backend.python
.. _python 2.7: http://www.python.org
.. _zero message queue: http://zeromq.org
.. _zmq: http://zeromq.org
.. _language bindings: http://zeromq.org/bindings:_start
.. _python bindings: http://zeromq.org/bindings:python
.. _markdown: http://daringfireball.net/projects/markdown/
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. _conda: https://conda.io/
.. _beat editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
.. _bob: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/doc/index.html
.. _idiap: http://www.idiap.ch
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