Logbk was initiated and is currently developed at the
Robotics Innovation Center of the
German Research Center for Artificial Intelligence (DFKI) in Bremen.
{ width=30% }
Logbk is a GUI application for researchers to specify, collect and validate metadata that emerge during experiments with different devices (e.g. rovers). Although Logbk runs in the browser, all data is stored locally first. This makes Logbk suitable for field trials, where internet access may not be guaranteed.
Install Python package inside a virtual environment using pip and venv:
# At the top level of the logbk repository:
python3 -m pip install --upgrade build pip setuptools wheel
python3 -m build
python3 -m venv env
source env/bin/activate
python3 -m pip install dist/logbk-0.0.1.tar.gz# Start the web server
# NOTE: Will use the default database ./logbk/logbk.db
./bin/logbk_cli
# OPTIONALLY: Start the web server with a database at a custom location
./bin/logbk_cli /path/to/the/database
# Open the app in your browser
firefox http://localhost:5000
{ width=50% }
As a minimum, you need to define all device names, before specifying any experiments in the next step. Other device parameters may be updated later.
{ width=50% }
{ width=50% }
{ width=50% }
This includes selecting a list of possible devices for each experiment, which is why the previous step was necessary.
{ width=50% }
{ width=50% }
{ width=50% }
CAUTION: Changing the specification of an existing experiment (i.e. going back to step 3) will re-create and thus empty its run table. Existing runs are saved in a backup table, so they are not lost, but they can no longer be accessed via the app.
{ width=50% }
{ width=50% }
{ width=50% }
Currently, this README is the entire documentation.
Currently, there are no automated tests.
Clone this repository and install the dependencies as described above.
Logbk is under active development.
To search for bugs or report them, please use GitHubs issue tracker at:
Semantic versioning is used, that is, the major version number will be incremented when the API changes in a backwards incompatible way, the minor version will be incremented when new functionality is added in a backwards compatible manner, and the patch version is incremented for bugfixes, documentation, etc.
Logbk is distributed under the 3-clause BSD license.
Authors:
- Christian Backe ([email protected])
- Malte Wirkus ([email protected])
Maintainers:
- Christian Backe ([email protected])
- Malte Wirkus ([email protected])
Logbk was developed as part of the project RoBivaL, funded by the German Federal Ministry for Economic Affairs and Climate Action (BMWK) under grant number 50RP2150.
Copyright 2024, DFKI GmbH / Robotics Innovation Center