Git Product home page Git Product logo

matlab's Introduction

dqrobotics-matlab

The DQ Robotics library in MATLAB.

Installation

Assuming that you already have Matlab installed on you computer, download the most recent Matlab toolbox of DQ Robotics here.

After downloading the file dqrobotics-YY-MM.mltbx, where YY-MM stands for the year and month of release, just open it and MATLAB should copy the files to the folder Toolboxes/dqrobotics-YY-MM in your $HOME folder and appropriately set the MATLAB path.

To test if the toolbox was installed correctly, just go to the prompt and type

>> DQ
ans = 
        0     

If you receive an error instead, it means that the toolbox was not properly installed and should open an issue here.

Development branch

Those wanting the results of our latest developments can checkout the master branch of the MATLAB repository. In order to use DQ Robotics on your MATLAB installation, and supposing you did the checkout at [PATH_TO_DQ_ROBOTICS_FOLDER], just add

[PATH_TO_DQ_ROBOTICS_FOLDER]/matlab/

and subfolders to your MATLAB path.

Gif containing the procedure for adding new folders to the MATLAB path

Note however, that the development branch is unstable and should not be used in production environments.

Updating your dqrobotics-matlab installation

DQ Robotics follows a biannual release schedule. Therefore, there will be new releases each April and October. Just go to the download page and get the latest version.

Examples

There are several examples inside the folder $HOME/Toolboxes/dqrobotics-YY-MM/examples. They range from robot modeling to constrained robot control.

Getting help

All classes and methods are well documented. To access their documentation, just type help CLASS_NAME. For instance, help DQ will show all methods available in the class DQ with their corresponding description. To show more information about a particular method or property, it suffices to type help CLASS_NAME/method; for instance, help DQ/plot will show the help for the plot function of the DQ class.

Although the library is self-contained and it suffices to know only basic dual quaternion algebra and robot modeling and control techniques to use it, there is a great amount of theory behind the controllers and modeling techniques implemented in DQ Robotics. Therefore, several methods and classes point to relevant references in the literature and users who want to better understand the implementation may find those references very useful.

Contributing

Contributing to dqrobotics-matlab follows the same criteria as for other parts of DQ Robotics. More information about the procedures for contributing can be found here.

matlab's People

Contributors

bvadorno avatar mmmarinho avatar juanjqo avatar htadashi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.