REC is a tool that aims to make data in robot executions FAIR. It is designed to configure, manage, organize and consolidate (meta)data used or generated by robots executing tasks or tests.

In your terminal, go to where you have cloned this repository and install it in editable mode:

pip install -e .

The current skeleton of the code allows you to run two examples: The MariaDBObserver and a Run.

An Observer is an interface to a type of data storage. For now, we have added a MariaDBObserver with some basic functionality. To test it you can run the following in your terminal:

python rec/observers/mariadb_observer.py

The example shows how to create a run object, attach an observer, and define the main function of your tests. You can test its basic functionality by running the script:

python examples/decentral_run.py

Create an .env file at the root of this repository and update the contents with your credentials and the IP of the server where its deployed:

MARIADB_USER="user"
MARIADB_PASSWORD="pass12345"
MARIADB_HOST="localhost"
MARIADB_PORT=3306

This tool is inspired by sacred, a tool to organize experiments for Machine Learning. We borrow small pieces of code under the MIT License, but have rewritten and simplified the framework for robotics.