This repository has been archived by the owner on Oct 8, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
self-generate RST README as travis-ci uses precise (12.04LTS) which i…
…s limited to pandoc (1.9.1.1-1) which seems to be bugged
- Loading branch information
Showing
3 changed files
with
96 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -364,6 +364,4 @@ ENV/ | |
|
||
.idea | ||
*.rej | ||
README.rst | ||
README | ||
VERSION |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
|PyPI Version| |GitHub tag| |DOI| |PyPI License| | ||
|
||
|PyPI Downloads| |PyPI Wheel| |PyPI Format| |PyPI Pythons| |PyPI | ||
Implementation| |PyPI Status| | ||
|
||
|Build Status| |CircleCI| | ||
|
||
|Dependency Status| |Coverage Status| |codecov| |Codacy Badge| |Code | ||
Climate| |Issue Count| | ||
|
||
pybotics | ||
======== | ||
|
||
Python Toolbox for Robotics | ||
|
||
Context | ||
------- | ||
|
||
Inspired from `Peter Corke's Robotics | ||
Toolbox <http://www.petercorke.com/Robotics_Toolbox.html>`__ for MATLAB. | ||
However, MATLAB is not necessarily widespread outside of academia (and I | ||
prefer Python), thus Pybotics was born. | ||
|
||
Requirements/Compatibility | ||
-------------------------- | ||
|
||
- `Python >= 3.4 <https://travis-ci.org/nnadeau/pybotics>`__ | ||
- See `requirements.txt <requirements.txt>`__ for package dependencies | ||
|
||
Applications and Usage | ||
---------------------- | ||
|
||
- `Kinematics <examples/example_kinematics.ipynb>`__ | ||
- `Calibration <examples/example_calibration.ipynb>`__ | ||
- Trajectory and path planning | ||
|
||
Contributing | ||
------------ | ||
|
||
1. Fork it! | ||
2. Create your feature branch | ||
3. Follow PEP 8 style guide | ||
4. Don't break the current codebase (without good reason) | ||
5. Have tests for all your code | ||
6. Submit a pull request :D | ||
|
||
Limitations | ||
----------- | ||
|
||
- Currently only supports `Modified Denavit–Hartenberg | ||
Parameters <https://en.wikipedia.org/wiki/Denavit%E2%80%93Hartenberg_parameters#Modified_DH_parameters>`__ | ||
|
||
References | ||
---------- | ||
|
||
- Craig, John J. Introduction to robotics: mechanics and control. Vol. | ||
3. Upper Saddle River: Pearson Prentice Hall, 2005. | ||
- Corke, Peter. Robotics, vision and control: fundamental algorithms in | ||
MATLAB. Vol. 73. Springer, 2011. | ||
|
||
.. |PyPI Version| image:: https://img.shields.io/pypi/v/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |GitHub tag| image:: https://img.shields.io/github/tag/nnadeau/pybotics.svg?maxAge=2592000?style=flat-square | ||
:target: https://github.com/nnadeau/pybotics/releases | ||
.. |DOI| image:: https://zenodo.org/badge/66797360.svg | ||
:target: https://zenodo.org/badge/latestdoi/66797360 | ||
.. |PyPI License| image:: https://img.shields.io/pypi/l/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Format| image:: https://img.shields.io/pypi/format/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Pythons| image:: https://img.shields.io/pypi/pyversions/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Implementation| image:: https://img.shields.io/pypi/implementation/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |PyPI Status| image:: https://img.shields.io/pypi/status/pybotics.svg | ||
:target: https://pypi.python.org/pypi/pybotics | ||
.. |Build Status| image:: https://travis-ci.org/nnadeau/pybotics.svg?branch=master | ||
:target: https://travis-ci.org/nnadeau/pybotics | ||
.. |CircleCI| image:: https://circleci.com/gh/nnadeau/pybotics/tree/master.svg?style=svg | ||
:target: https://circleci.com/gh/nnadeau/pybotics/tree/master | ||
.. |Dependency Status| image:: https://www.versioneye.com/user/projects/57d87a4a7129660045cf3a58/badge.svg?style=flat-square | ||
:target: https://www.versioneye.com/user/projects/57d87a4a7129660045cf3a58 | ||
.. |Coverage Status| image:: https://coveralls.io/repos/github/nnadeau/pybotics/badge.svg?branch=master | ||
:target: https://coveralls.io/github/nnadeau/pybotics?branch=master | ||
.. |codecov| image:: https://codecov.io/gh/nnadeau/pybotics/branch/master/graph/badge.svg | ||
:target: https://codecov.io/gh/nnadeau/pybotics | ||
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/9d4f77b167874a049e97731181e2b53a | ||
:target: https://www.codacy.com/app/nicholas-nadeau/pybotics?utm_source=github.com&utm_medium=referral&utm_content=nnadeau/pybotics&utm_campaign=Badge_Grade | ||
.. |Code Climate| image:: https://codeclimate.com/github/nnadeau/pybotics/badges/gpa.svg | ||
:target: https://codeclimate.com/github/nnadeau/pybotics | ||
.. |Issue Count| image:: https://codeclimate.com/github/nnadeau/pybotics/badges/issue_count.svg | ||
:target: https://codeclimate.com/github/nnadeau/pybotics |