Skip to content
Snippets Groups Projects
Commit 4922ef9a authored by Philip ABBET's avatar Philip ABBET
Browse files

Modify the README

parent 9a16e9ca
No related branches found
No related tags found
1 merge request!14Add support to serve databases from a docker container
Pipeline #
...@@ -63,6 +63,7 @@ In particular, this package controls memory and CPU utilisation of the ...@@ -63,6 +63,7 @@ In particular, this package controls memory and CPU utilisation of the
containers it launches. You must make sure to enable those functionalities on containers it launches. You must make sure to enable those functionalities on
your installation. your installation.
Docker Setup Docker Setup
============ ============
...@@ -75,14 +76,16 @@ execute algorithms or experiments. ...@@ -75,14 +76,16 @@ execute algorithms or experiments.
We use specific docker images to run user algorithms. Download the following We use specific docker images to run user algorithms. Download the following
base images before you try to run tests or experiments on your computer:: base images before you try to run tests or experiments on your computer::
$ docker pull beats/py27:system $ docker pull docker.idiap.ch/beat/beat.env.system.python:system
$ docker pull debian:8.4 $ docker pull docker.idiap.ch/beat/beat.env.db.examples:1.0.0
Optionally, also download the following images to be able to re-run experiments Optionally, also download the following images to be able to re-run experiments
downloaded from the BEAT platform (not required for unit testing):: downloaded from the BEAT platform (not required for unit testing)::
$ docker pull beats/py27:0.0.4 $ docker pull docker.idiap.ch/beat/beat.env.python:0.0.4
$ docker pull beats/py27:0.1.0 $ docker pull docker.idiap.ch/beat/beat.env.python:0.1.0
$ docker pull docker.idiap.ch/beat/beat.env.cxx:1.0.1
$ docker pull docker.idiap.ch/beat/beat.env.db:1.0.0
Documentation Documentation
...@@ -139,7 +142,6 @@ sphinx:: ...@@ -139,7 +142,6 @@ sphinx::
Development Development
----------- -----------
Indentation Indentation
=========== ===========
...@@ -148,8 +150,8 @@ example, to enforce compliance on a single file and edit it in place, do:: ...@@ -148,8 +150,8 @@ example, to enforce compliance on a single file and edit it in place, do::
$ ./bin/autopep8 --indent-size=2 --in-place beat/core/utils.py $ ./bin/autopep8 --indent-size=2 --in-place beat/core/utils.py
We normally use 2-space identattion. If ever, you can easily change the We normally use 2-space indentation. If ever, you can easily change the
identation to 4 spaces like this:: indentation to 4 spaces like this::
$ ./bin/autopep8 --indent-size=4 --in-place beat/core/utils.py $ ./bin/autopep8 --indent-size=4 --in-place beat/core/utils.py
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment