A set of convenient logging and testing tools for the Drake robotics toolbox.
Project description
brom_drake-py
Brom is a helper library for the Drake robotics simulation and verification library. Its goal is to simplify common debugging and testing activities in Drake (for example, logging the outputs of systems in your block diagrams).
Some of Brom's features:
| Feature | Code | Results |
|---|---|---|
The Diagram Watcher (the DiagramWatcher will log + plot all output ports of your Diagram automatically) |
add_watcher_and_build() |
|
| The Drake-ify feature (converts your URDF file into a form that Drake can consume) | drakeify_my_urdf() |
|
| Productions (partially complete robot scenarios to test your algorithms) | (See Examples Directory or the Docs) | |
Puppeteer (Move free bodies in drake with a RigidTransform input) |
Puppetmaker class's methods |
To learn more, look through our documentation here.
Installation
brom_drake is available on PyPI and installable with pip:
pip install brom-drake
Developer install
You can also install the package during local development by cloning the repository and running the following commands from inside it:
pip install -r requirements.txt
pip install -e .
Citation
Feel free to cite this project if it helped with your work!
@misc{bromDrake2024,
author = "Kwesi Rutledge and the Wrench Robotics Team",
title = "Brom: A Helper Library for the Drake Toolbox",
year = 2024,
}
FAQs
Why the name Brom?
Brom the storyteller is a character from the Inheritance series by Christopher Paolini. He is a wise mentor that helps Eragon (the protagonist) master dragons. ;)
Where are the release notes?
You can follow the development of Brom by:
- Following the Release Notes on Substack ([Substack])
- Studying the Pull Requests (available above in the
Pull Requeststab of GitHub), or
How can I support this project?
Feel free to create an issue/send the Wrench Robotics team a message if you're interested in helping out!
Related Work
Some other work in the open-source Drake community:
- kinova_drake - A Drake-based library that builds a simple version of the manipulation station for the Kinova Gen3 robot arm. Also works with the hardware.
- airo-drake - A python package meant to simplify
working with Drake and the
airo-monorepository from the AI and Robotics Lab at Ghent University.
To-Dos
- Figure out how to tell if two systems are connected in Drake.
- Add more readme explanations of what is going on under the hood.
- Create a method that makes each material in a URDF file have unique names if they have specific values
- Allow for the user to give "Drake-unfriendly" URDFs to
ShowMeThisModelproduction
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file brom_drake-0.5.3.tar.gz.
File metadata
- Download URL: brom_drake-0.5.3.tar.gz
- Upload date:
- Size: 27.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c26bea6bb06b0077358dccbbe70638d6e419094a8e71f17f846839274affd953
|
|
| MD5 |
bad8806f2ea1005a8492515686ca4d84
|
|
| BLAKE2b-256 |
57c0983110a1c91101583b4938967a149afe5d16e5f146482b2d236c12b622b3
|
Provenance
The following attestation bundles were made for brom_drake-0.5.3.tar.gz:
Publisher:
deploy-to-pypi.yml on kwesiRutledge/brom_drake-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brom_drake-0.5.3.tar.gz -
Subject digest:
c26bea6bb06b0077358dccbbe70638d6e419094a8e71f17f846839274affd953 - Sigstore transparency entry: 955964001
- Sigstore integration time:
-
Permalink:
kwesiRutledge/brom_drake-py@8ece4384a7e5aa13a2da7be4a280b915246e350d -
Branch / Tag:
refs/tags/0.5.3 - Owner: https://github.com/kwesiRutledge
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-to-pypi.yml@8ece4384a7e5aa13a2da7be4a280b915246e350d -
Trigger Event:
push
-
Statement type:
File details
Details for the file brom_drake-0.5.3-py3-none-any.whl.
File metadata
- Download URL: brom_drake-0.5.3-py3-none-any.whl
- Upload date:
- Size: 27.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba7183b5c391208e6cb34e131fe764670489eaf9e8e9bb7a70bb6c79ec0a25e8
|
|
| MD5 |
e0ac7b4b668e210e35ea74d6379c3a16
|
|
| BLAKE2b-256 |
eb0eb108122a4d7859759fe7c7bc9f172eb34a062b796c50d2d24a6b71308175
|
Provenance
The following attestation bundles were made for brom_drake-0.5.3-py3-none-any.whl:
Publisher:
deploy-to-pypi.yml on kwesiRutledge/brom_drake-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brom_drake-0.5.3-py3-none-any.whl -
Subject digest:
ba7183b5c391208e6cb34e131fe764670489eaf9e8e9bb7a70bb6c79ec0a25e8 - Sigstore transparency entry: 955964005
- Sigstore integration time:
-
Permalink:
kwesiRutledge/brom_drake-py@8ece4384a7e5aa13a2da7be4a280b915246e350d -
Branch / Tag:
refs/tags/0.5.3 - Owner: https://github.com/kwesiRutledge
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-to-pypi.yml@8ece4384a7e5aa13a2da7be4a280b915246e350d -
Trigger Event:
push
-
Statement type: