codecov sphinx

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() Creation of Brom Directory
The Drake-ify feature (converts your URDF file into a form that Drake can consume) drakeify_my_urdf() Drakeify Example
Productions (partially complete robot scenarios to test your algorithms) (See Examples Directory or the Docs) Kinematic Motion Planning Example
Puppeteer (Move free bodies in drake with a RigidTransform input) Puppetmaker class's methods A cube being moved using the Puppetmaker'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

ROS 2-capable install

If you use ROS 2 package URIs (for example, package://...) and want brom_drake to resolve package share directories via ament_index_python, install the optional ROS 2 extra:

pip install "brom-drake[ros2]"

In most ROS 2 workflows, make sure your ROS 2 environment is sourced before running your scripts so package discovery works as expected.

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 Requests tab 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-mono repository 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 ShowMeThisModel production

Project links

Data verified by PyPI on Aug 23, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for kwesir from gravatar.com kwesir

Credits

Author: Kwesi Rutledge

GitHub Statistics

Data verified by PyPI on Aug 23, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python >=3.14

Provides Extra

test dev ros2

Tags

drake robotics testing logging

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brom_drake-1.0.0.post2.tar.gz (27.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

brom_drake-1.0.0.post2-py3-none-any.whl (27.8 MB view details)

Uploaded Python 3

File details

Details for the file brom_drake-1.0.0.post2.tar.gz.

File metadata

  • Download URL: brom_drake-1.0.0.post2.tar.gz
  • Upload date:
  • Size: 27.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for brom_drake-1.0.0.post2.tar.gz
Algorithm Hash digest
SHA256 77ab085aa8a4498aa10f3c760afdb78c681cc7acb1417c297196c41af5d8cc06
MD5 1ed732917ea37105de86631bfb70a00d
BLAKE2b-256 70dd4884f9964ca8e616c0995bbb9d5f6428be73773b33516a411aecc3e5b13b

See more details on using hashes here.

Provenance

The following attestation bundles were made for brom_drake-1.0.0.post2.tar.gz:

Publisher: deploy-to-pypi.yml on kwesiRutledge/brom_drake-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file brom_drake-1.0.0.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for brom_drake-1.0.0.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 699d5acb29f39d27577d412f9c5f5d6cdba3eb11b7131aae6990fe5592123f28
MD5 c350b3f6236bac0c6c75c1f3673b9731
BLAKE2b-256 4062e32dfcf7fa67bf2f66874c6c11163fe15a124a1bfc7533ba50987b9870ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for brom_drake-1.0.0.post2-py3-none-any.whl:

Publisher: deploy-to-pypi.yml on kwesiRutledge/brom_drake-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.0.0.post2 This release

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1.post1

2 files

0.5.1

2 files

0.5.0

2 files

0.4.7.post4

2 files

0.4.7.post3

2 files

0.4.7.post2

2 files

0.4.7.post1

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3.post1

2 files

0.4.3

2 files

0.4.2.post1

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0.post1

2 files

0.4.0

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5.post1

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.2.post2

2 files

0.0.2

2 files

0.0.1.post3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page