RSSTP

Repository for the Robotic Sensorimotor System Testing Platform (RSSTP) project, carried out in the University of Oulu.

Installation

Python 3.10 is necessary for this library to work.

python -m venv venv
source ./venv/bin/activate OR .\venv\Scripts\Activate.ps1 FOR WINDOWS
pip install -r requirements.txt

Check requirements.txt for libraries needed by the developer.

Check setup.py for libraries needed for the software to run.

Ensure that installation has been successful by navigating to demos/ and running the demo_msrgym.py demo with python:

python demo_msrgym.py

How to use

Demos located in demos/ provide a practical explanation of the library usage.

Testing

Testing is done using pytest. To run the tests navigate to the tests folder and run pytest (after installation step):

pytest

Documentation

To see the pdoc auto-generated documentation run the following command while in the RSTTP folder:

pdoc --html --output-dir build src

Then navigate to build/src and open index.html with your favourite browser.