Commit 8a2b5fd5 authored by Jaden's avatar Jaden
Browse files

fleshed out walkthrough

parent 6a0ebdc1
......@@ -31,8 +31,9 @@ experiments locally. The topics covered are the following:
- Preparing a proper Python environment
- Bootstrapping ``beat.cmdline``
- Running the `BEAT Platform <https://gitlab.idiap.ch/beat/beat.web>`_ locally
- Introducing a possible workflow for BEAT development
- Running the `BEAT web platform <https://gitlab.idiap.ch/beat/beat.web>`_
locally
- Detailing an example workflow for BEAT development
Tips for preparing a proper environment
.......................................
......@@ -46,6 +47,8 @@ Tips for preparing a proper environment
- 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``
.............................
......@@ -62,5 +65,37 @@ Thanks to Buildout, setup is simple:
Running the BEAT Platform locally
.................................
- Build
`the BEAT web environment <https://gitlab.idiap.ch/beat/beat.env.web>`_
locally.
- 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,
etc.).
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``.
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