Robot Analysis Infrastructure
Project description
Robot Analysis Interface
The Robot Analysis Interface (RAI
) is a package to analyze
synchronously sensors data and video captures of the scene from robotic experiments.
It is written in Python
and uses Qt
and OpenCV
bindings under the hood.
It is supported on Linux
operating systems.
Dependencies
RAI
has the following dependencies:
The setup.py
will take care of installing these packages.
However, you can also install them manually by running:
$ pip install -r requirements
which will also install the dependencies for building the documentation.
Installation
RAI
releases can be instaled from PyPI by doing
$ pip install robot_analysis_interface
If you prefer to install from source, clone this repository, go to the root directory and type in
$ pip install .
or directly on the compressed file:
$ pip install robot_analysis_interface-xx.tar.gz
NOTE
It is recommended to install everything in a dedicated virtual environment.
Getting started
Quick way to open a data file/folder:
To open a data file or folder, you can use the script provided in this repository. Several type of data can be parsed:
- The SL
d-file
format:
$ rai --data=d00021 --session=my_session.json
- A file dumped from the
DataCollector
class available from the RAI API:
$ rai --data=data_collector_file.npy --session=my_session.json
$ rai --data=data_collector_file.npz --session=my_session.json
- A data folder dumped by the dynamic-graph framework.
$ rai --data=2019-08-12_02-03-19/ --session=my_session.json
- The default behavior looks for the newest data file/folder that are dumped by the dynamic-graph or SL is the current folder.
$ rai
Note from these commands:
- the (optional) data file or folder defined with the
--data
argument, - the (optional) JSON file one can use to define to restore a RAI session with the
--session
argument, - without the
--data
argument the launcher looks into the current folder for a folder with the highest date name (e.g.2019-08-12_02-03-19
), if none are found, it looks for the d-file with the highest index. - without
--session
argument the launcher open a clean session.
Using the RAI python interface
To use the RAI, import the package in your Python session:
>>> import RAI
RAI comes with demos, which can be run using the following commands:
>>> RAI.demos.demo()
Documentation
The full documentation can be found here.
It can also be built from source the following way:
$ pip install sphinx sphinx_bootstrap_theme
$ cd doc
$ make html
and open the file build/html/index.html
in your web browser.
Unit test
The RAI has been tested using the Python unit testing framework. The tests can be run using the following command in the root directory:
python -m unittest discover
It is also possible to run the tests using nose:
pip install nose
nosetests -v tests
If you wish to run headless tests, use xvfb.
Authors
Jean-Claude Passy jean-claude.passy@tuebingen.mpg.de
Maximilien Naveau maximilien.naveau@tuebingen.mpg.de
License
BSD 3-Clause (see LICENSE.md)
Copyright
© 2017, Max Planck Society / Software Workshop - Max Planck Institute for Intelligent Systems
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file robot_analysis_interface-1.0.tar.gz
.
File metadata
- Download URL: robot_analysis_interface-1.0.tar.gz
- Upload date:
- Size: 11.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0da0c974fa0adee3498ee719a38376f96cba330741f96fd251052a0f90b39b72 |
|
MD5 | b24129893d4d199657a5713b880bcd0f |
|
BLAKE2b-256 | 1747a3852e18b17246647261334304d39b5c6fb0bad59439b03963e7ea6fa2ec |
File details
Details for the file robot_analysis_interface-1.0-py3-none-any.whl
.
File metadata
- Download URL: robot_analysis_interface-1.0-py3-none-any.whl
- Upload date:
- Size: 12.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 630b97b41723c1b973b3a0c64e6491cf97b3ec03e1cee787a57463c0c9980035 |
|
MD5 | e7c84dbe5a832cec0ce4bfc066661cae |
|
BLAKE2b-256 | 9f77db2e9c4c66a0ddb281507df01232a4e3f750d9655ccdf00e0cc930a2ce8b |