Changes

Page history
Modified to accomodate instructions for creating new databases authored by André Anjos's avatar André Anjos
Show whitespace changes
Inline Side-by-side
home.markdown
View page @ 2fca63ae
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
BEAT Databases are simply accessor plugins that allow the data belonging to a database to be read and fed into a BEAT Toolchain in the context of an Experiment. The accessors are called *views* in the BEAT jargon. Here is an UML diagram that explains the relationship of all components of a database successfuly integrated into the platform: BEAT Databases are simply accessor plugins that allow the data belonging to a database to be read and fed into a BEAT Toolchain in the context of an Experiment. The accessors are called *views* in the BEAT jargon. Here is an UML diagram that explains the relationship of all components of a database successfuly integrated into the platform:
![database-uml](https://gitlab.idiap.ch/uploads/biometric/beat.databases/0354a72407/database-uml.png) ![database-uml](https://gitlab.idiap.ch/uploads/biometric/beat.databases/0354a72407/database-uml.png =250x)
## Components ## Components
...@@ -26,7 +26,7 @@ Once your Python code is ready, the next thing to do is to install a developemen ...@@ -26,7 +26,7 @@ Once your Python code is ready, the next thing to do is to install a developemen
### Step 3: Add your database JSON and Views to beat.databases ### Step 3: Add your database JSON and Views to beat.databases
Inside `beat.web`, you'll find a checkout of `beat.databases` in `src/beat.databases`. Go ahead and create the view files and JSON descriptors matching the existing structure. JSON descriptors are inserted into `<beat.databases-root>/beat/databases/prefix/advanced/databases`. Views are inserted into <beat.databases-root>/beat/databases/<database-name>`. Add your database satellite package to the `setup.py` of `beat.databases. Inside `beat.web`, you'll find a checkout of `beat.databases` in `src/beat.databases`. Go ahead and create the view files and JSON descriptors matching the existing structure. JSON descriptors are inserted into `<beat.databases-root>/beat/databases/prefix/advanced/databases`. Views are inserted into `<beat.databases-root>/beat/databases/<database-name>`. Add your database satellite package to the `setup.py` of `beat.databases.
> Note: If your Bob satellite package for the database is **not** available on PyPI, you must also add a > Note: If your Bob satellite package for the database is **not** available on PyPI, you must also add a
> checkout/mr.developer line on `beat.web/buildout.cfg` so that the system can properly download and install it > checkout/mr.developer line on `beat.web/buildout.cfg` so that the system can properly download and install it
... ...
......