Commit dbe4ce98 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI
Browse files

[cmline][doc] removed walkthtrough from docs

parent 1eb1f01c
......@@ -46,7 +46,6 @@ implement more advanced functionality than this client (``beat``) provides.
.. vim: set fileencoding=utf-8 :
.. Copyright (c) 2016 Idiap Research Institute, ..
.. Contact: ..
.. ..
.. 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 ..
.. ..
.. 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 ..
.. ..
.. You should have received a copy of the GNU Affero Public License along ..
.. with the BEAT platform. If not, see ..
.. _beat-cmdline-walkthrough:
This page gives an overview on setting up an environment to develop BEAT
experiments locally. The topics covered are the following:
- Preparing a proper Python environment
- Bootstrapping ``beat.cmdline``
- Running the `BEAT web platform <>`_
- Detailing an example workflow for BEAT development
Tips for preparing a proper environment
- Using a `Conda <>`_ environment is recommended.
- ``beat.cmdline`` requires Python 2.7 and will not work on Python 3.x.
- It uses `Buildout <>`_, to bootstrap,
commonly known as `zc.buildout`. This package is also available on Conda.
- The Python 2.7 environment used for bootstrapping will also be the
environment used to execute BEAT code when using the local executor.
- While you can bootstrap and use ``beat.cmdline`` without having a local
BEAT instance, ``beat`` can't yet create BEAT objects (experiments, etc.)
from scratch. We recommend you instead modify existing BEAT objects.
- Running experiments using the Docker executor requires Docker to be
set up locally and several docker containers.
Boostrapping ``beat.cmdline``
Thanks to Buildout, setup is simple:
- Clone the ``beat.cmdline`` repository.
- Using a compatible environment (see above) run ``buildout`` in the project's
root directory. Assuming this step is successful, the ``beat`` tool is now
- To build this documentation locally, use the ``sphinx-build`` tool in
``bin/``: ``./bin/sphinx-build doc/ sphinx/`` to output to ``sphinx/``.
Running the BEAT Platform locally
- Build
`the BEAT web environment <>`_
- Build ``beat.web`` using the Python environment built from ``beat.env.web``.
- Install the example environment in ``beat.web`` via ``./bin/django install``.
- Run ``./bin/django runserver`` and go to ``localhost:8000/`` to see if it
works. The default example login is ``user`` with password ``user``.
An example workflow
First, have ``beat.web`` running locally. To interact with the local instance
through ``beat.cmdline``, set the ``platform`` config option through ``beat``
to ``http://localhost:8000/``: ``beat set platform 'http://localhost:8080/'``.
Pull example experiments from the platform via the ``beat`` tool:
``beat exp pull user/single/1``. Run the example experiment using the
local executor: ``beat exp run user/single/1/single`` to make sure one works.
Fork the ``single`` experiment, using the same ``user/single/1`` toolchain:
``beat exp fork user/single/1/single user/single/1/single_test``.
Run the new experiment to make sure the fork works:
``beat exp run user/single/1/single_test``.
Feel free to edit the ``single_test`` JSON file to change the experiment.
Likewise, you can fork other BEAT objects (algorithms, databases, toolchains,
To see if your new BEAT objects will run on the BEAT platform, try to run
using the Docker executor (which will use the BEAT docker images it can find):
``beat exp run --docker user/single/1/single_test``.
If it works, you can push it to your BEAT platform to have it on your BEAT
platform instance: ``beat exp push``.
Supports Markdown
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