Skip to content

Add MoveIt Python Library Citation #2029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henningkayser merged 1 commit into from
Apr 4, 2023
Merged

Add MoveIt Python Library Citation #2029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions moveit_py/CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cff-version: 1.2.0
authors:
- family-names: Fagan
given-names: Peter David
date-released: 2023-03-20
message: "If you use this software, please cite it as below."
title: "MoveIt 2 Python Library: A Software Library for Robotics Education and Research"
url: "https://github.com/ros-planning/moveit2/tree/main/moveit_py"
11 changes: 11 additions & 0 deletions moveit_py/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,16 @@ Community contributions are welcome.

For detailed contribution guidelines please consult the official [MoveIt contribution guidelines](https://moveit.ros.org/documentation/contributing/).

## Citing the Library
If you use this library in your work please use the following citation:
```bibtex
@software{fagan2023moveitpy,
author = {Fagan, Peter David},
title = {{MoveIt 2 Python Library: A Software Library for Robotics Education and Research}},
url = {https://github.com/ros-planning/moveit2/tree/main/moveit_py},
year = {2023}
}
```

## Acknowledgements
Thank you to the [Google Summer of Code program](https://summerofcode.withgoogle.com/) for sponsoring the development of this Python library. Thank you to the MoveIt maintainers Henning Kayser (@henningkayser) and Michael Gorner (@v4hn) for their guidance as supervisors of my GSoC project. Finally thank you to the [ML Collective](https://mlcollective.org/) for providing compute support for this project.