LBR-Stack

LBR-Stack: ROS 2 and Python Integration of KUKA FRI for Med and IIWA Robots - Published in JOSS (2024)

https://github.com/lbr-stack/lbr_stack_doc

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Last synced: 6 months ago · JSON representation ·

Repository

Documentation for the LBR-Stack

Basic Info

Host: GitHub
Owner: lbr-stack
License: apache-2.0
Language: TeX
Default Branch: main
Homepage:
Size: 1.11 MB

Statistics

Stars: 7
Watchers: 1
Forks: 0
Open Issues: 5
Releases: 1

Created almost 3 years ago · Last pushed over 1 year ago

Metadata Files

Readme Contributing License Code of conduct Citation

lbrstackdoc

This repository holds the documentation for the LBR-Stack.

Build Documentation Locally

To build locally: 1. Clone this repository

```shell
git clone --recursive git@github.com:lbr-stack/lbr_stack_doc.git
cd lbr_stack_doc
```

Create a virtual environment

shell python3 -m venv ./lbr_stack_doc_venv source lbr_stack_doc_venv/bin/activate
Install dependencies

shell pip3 install -r requirements.txt
Clone the lbr_fri_ros2_stack, e.g. via (this uses vcs)

shell wget https://raw.githubusercontent.com/lbr-stack/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos-fri-1.15.yaml vcs import doc/source < repos-fri-1.15.yaml
Clone pyfri

shell git clone https://github.com/lbr-stack/pyfri.git doc/source/pyfri
In conf.py change

python f"doxysphinx build . $READTHEDOCS_OUTPUT/html {doxyfile}", shell=True

to

python f"doxysphinx build . html {doxyfile}", shell=True
Finally, go to doc/source and run

shell python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . html
Open and browse the documentation by opening doc/source/html/index.html.

Build Paper Locally

To build the paper via Docker, run

shell docker run --rm -it \ -v $PWD:/data \ -u $(id -u):$(id -g) \ openjournals/inara \ -o pdf,crossref,preprint \ paper/paper.md

inside the lbr_stack_doc repository.

Citation

If you enjoyed using this repository for your work, we would really appreciate ❤️ if you could leave a ⭐ and / or cite it, as it helps us to continue offering support.

@misc{huber2023lbrstack, title={LBR-Stack: ROS 2 and Python Integration of KUKA FRI for Med and IIWA Robots}, author={Martin Huber and Christopher E. Mower and Sebastien Ourselin and Tom Vercauteren and Christos Bergeles}, year={2023}, eprint={2311.12709}, archivePrefix={arXiv}, primaryClass={cs.RO} }

Acknowledgements

This work was supported by core and project funding from the Wellcome/EPSRC [WT203148/Z/16/Z; NS/A000049/1; WT101957; NS/A000027/1].

This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101016985 (FAROS project).

Owner

Name: lbr-stack
Login: lbr-stack
Kind: organization

Repositories: 1
Profile: https://github.com/lbr-stack

JOSS Publication

LBR-Stack: ROS 2 and Python Integration of KUKA FRI for Med and IIWA Robots

Published

November 15, 2024

DOI

10.21105/joss.06138

Volume 9, Issue 103, Page 6138