Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2efb3ea

Browse filesBrowse files
committed
Add citation information and new badges
1 parent 0e5726c commit 2efb3ea
Copy full SHA for 2efb3ea

File tree

Expand file treeCollapse file tree

1 file changed

+37
-1
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+37
-1
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+37-1Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Spatial Maths for Python
22

3+
[![A Python Robotics Package](https://raw.githubusercontent.com/petercorke/robotics-toolbox-python/master/.github/svg/py_collection.min.svg)](https://github.com/petercorke/robotics-toolbox-python)
4+
[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io)
5+
36
[![PyPI version](https://badge.fury.io/py/spatialmath-python.svg)](https://badge.fury.io/py/spatialmath-python)
47
[![Anaconda version](https://anaconda.org/conda-forge/spatialmath-python/badges/version.svg)](https://anaconda.org/conda-forge/spatialmath-python)
58
![Python Version](https://img.shields.io/pypi/pyversions/roboticstoolbox-python.svg)
69
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7-
[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io)
810

911
[![Build Status](https://github.com/petercorke/spatialmath-python/workflows/build/badge.svg?branch=master)](https://github.com/petercorke/spatialmath-python/actions?query=workflow%3Abuild)
1012
[![Coverage](https://codecov.io/gh/petercorke/spatialmath-python/branch/master/graph/badge.svg)](https://codecov.io/gh/petercorke/spatialmath-python)
@@ -77,6 +79,40 @@ The class, method and functions names largely mirror those of the MATLAB toolbox
7779

7880
![animation video](./docs/figs/animate.gif)
7981

82+
# Citing
83+
84+
Check out our ICRA 2021 paper on [IEEE Xplore](https://ieeexplore.ieee.org/document/9561366) or get the PDF from [Peter's website](https://bit.ly/icra_rtb). This describes the [Robotics Toolbox for Python](https://github.com/petercorke/robotics-toolbox-python) as well Spatial Maths.
85+
86+
If the toolbox helped you in your research, please cite
87+
88+
```
89+
@inproceedings{rtb,
90+
title={Not your grandmother’s toolbox--the Robotics Toolbox reinvented for Python},
91+
author={Corke, Peter and Haviland, Jesse},
92+
booktitle={2021 IEEE International Conference on Robotics and Automation (ICRA)},
93+
pages={11357--11363},
94+
year={2021},
95+
organization={IEEE}
96+
}
97+
```
98+
99+
<br>
100+
101+
<a id='6'></a>
102+
103+
## Using the Toolbox in your Open Source Code?
104+
105+
If you are using the Toolbox in your open source code, feel free to add our badge to your readme!
106+
107+
[![Powered by the Robotics Toolbox](https://github.com/petercorke/spatialmath-python/raw/master/.github/svg/sm_powered.min.svg)](https://github.com/petercorke/spatialmath-python)
108+
109+
Simply copy the following
110+
111+
```
112+
[![Powered by the Spatial Math Toolbox](https://github.com/petercorke/spatialmath-python/raw/master/.github/svg/sm_powered.min.svg)](https://github.com/petercorke/spatialmath-python)
113+
```
114+
115+
80116
# Installation
81117

82118
## Using pip

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.