Skip to content

Commit

Permalink
Add citation
Browse files Browse the repository at this point in the history
  • Loading branch information
JeanElsner committed Nov 18, 2023
1 parent 02a7b06 commit e64f377
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Elsner"
given-names: "Jean"
orcid: "https://orcid.org/0000-0003-2691-0099"
title: "panda-py"
url: "https://github.com/JeanElsner/panda-py"
preferred-citation:
type: article
authors:
- family-names: "Elsner"
given-names: "Jean"
orcid: "https://orcid.org/0000-0003-2691-0099"
doi: "https://doi.org/10.1016/j.softx.2023.101532"
url: "https://www.sciencedirect.com/science/article/pii/S2352711023002285"
journal: "SoftwareX"
start: 101532
title: "Taming the Panda with Python: A powerful duo for seamless robotics programming and integration"
issn: "2352-7110"
volume: 24
year: 2023
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,21 @@ in the repository's root directory.
Hardware-in-the-loop operation requires `panda-py` to control the robot. However, the version automatically installed from PyPI may not be compatible with your robot if you use an older firmware or use the new Franka Research 3 robot. In that case refer to the panda-py [instructions](https://github.com/JeanElsner/panda-py#libfranka-version) on what version to install and where to find it.

If you're having trouble running the included viewer or rendering scenes, please refer to the requirements of [dm_control](https://github.com/google-deepmind/dm_control#rendering).

# Citation

If you use dm_robotics_panda in published research, please consider citing the [original software paper](https://www.sciencedirect.com/science/article/pii/S2352711023002285).

```
@article{elsner2023taming,
title = {Taming the Panda with Python: A powerful duo for seamless robotics programming and integration},
journal = {SoftwareX},
volume = {24},
pages = {101532},
year = {2023},
issn = {2352-7110},
doi = {https://doi.org/10.1016/j.softx.2023.101532},
url = {https://www.sciencedirect.com/science/article/pii/S2352711023002285},
author = {Jean Elsner}
}
```

0 comments on commit e64f377

Please sign in to comment.