Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.83 KB

README.md

File metadata and controls

65 lines (45 loc) · 2.83 KB

DQ Robotics

DQ Robotics is a standalone open-source (LGPLv3) library for robot modelling and control. It provides dual quaternion algebra and kinematic calculation algorithms in Python3, Matlab, and C++11.

Quick Start (Python)

User-wide installation

If you have no idea what a virtual enviroment means, this is probably for you.

python3 -m pip install --user dqrobotics

Isolated installation

It is a good practice to isolate projects using venv whenever you can.

python3 -m venv venv
source venv/bin/activate
python3 -m pip install dqrobotics

Documentation

Installation instructions for C++11, MATLAB, and interface packages are available at the project's readthedocs.

Learn

Questions?

Whether you are a beginner or advanced user, you're welcome to ask and answer questions about how to use the library, etc. in our Q&A section. Before you ask a new question, we ask members to skim through the forum to verify if their question has already been answered.

Citation

If you have used this library as part of your academic work, cite it as follows

@article{Adorno-Marinho2020,
archivePrefix = {arXiv},
arxivId = {1910.11612},
author = {Adorno, Bruno Vilhena and  Marinho, Murilo Marques},
doi = {10.1109/MRA.2020.2997920},
eprint = {1910.11612},
issn = {1070-9932},
journal = {IEEE Robotics {\&} Automation Magazine},
pages = {102--116},
month = sep,
volume = {28},
number = {3},
title = {DQ Robotics: A Library for Robot Modeling and Control},
url = {https://ieeexplore.ieee.org/document/9136790/},
year = {2021}
}

Contributing

DQ Robotics is a standalone, fully moderated open-source library, with a core developer team who determines the directions of new developments. To ensure quality control, the team follows a scrict procedure for new pull requests, described here.

Anyone wanting to propose a new modification or introduce new functionality should reach out to the team first, as proposed modifications that do not comply with the development philosophy and style, do not follow the library's architecture, don't introduce a clear and general benefit to the library other than to the person who proposed the modification will likely be rejected with no further discussion.

A good place to initiate such a discussion might be in the discussion forum.