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


.. _toolchains:

============
 Toolchains
============

Toolchains are the backbone of experiments within the |project| platform. They
determine the data flow for experiments in the |project| platform. For more information
about toolchains see the "Toolchains" section of "Getting Started with BEAT" in `BEAT documentation`_.


The *Toolchains* tab
--------------------

To open the *Toolchains* tab, you have to click on the tab 'User Resources'
from your homepage and select 'Toolchains'. On this window, you can search a
toolchain by typing a toolchain name in the 'Filter rows' search bar.

The image below shows the 'Toolchains' tab and the 'Filter rows' search
bar (red rectangles):

.. image:: img/search-toolchain.*

Some buttons are available for each toolchain:

   * ``New experiment``: to create a new experiment based on the toolchain.
   * ``Search experiments``: to show the experiments performed on this toolchain
   * ``Fork``: to fork this toolchain (see section :ref:'modifytoolchain'). When
     you fork a toolchain, you have to give it a new name.

And some more buttons if you own the toolchain:

   * ``New version``: to create a new version of this toolchain. The toolchain
     will keep the same name and the version number will be incremented when
     you click on this button.
   * ``Share``: to share this toolchain with any number of parties you wish.
   * ``Edit``: to modify this toolchain (**only available if this toolchain
     has not been used in an experiment**).
   * ``Delete``: to delete this toolchain (**only available if this toolchain
     has not been used in an experiment**).


Sharing a toolchain
-------------------

Like any other object in the |project| platform, you may also share your
toolchain your with other users. To do this, click on the green arrow in
the top right region on the page showing the toolchain you want to share.

.. note:: **Sharing status**

   The sharing status of an toolchain is represented to the left of its name,
   in the format of an icon. A toolchain can be in one of these three
   sharing states:

     * **Private** (icon shows a single person): If an toolchain is private,
       only you can use it on your experiments and only you can view its
       block diagram.
     * **Shared** (icon shows many persons): If an toolchain is shared, only
       people on the sharing list can use the toolchain on their experiments
       and view its block diagram.
     * **Public** (icon shows the globe): If an toolchain is public, then
       users and platform visitors can view its block diagram. All platform
       users can use the toolchain on their experiments.

   Sharing at the |project| platform is an irreversible procedure. For example,
   public objects cannot be made private again. If you share an object with a
   user or team and change your mind, you can still delete the object, for as
   long as it is not being used by you or another colleagues with access (see
   more information on our :ref:`faq`).


.. include:: ../links.rst