Skip to main content

A set of convenient logging and testing tools for the Drake robotics toolbox.

Project description

codecov

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 Wiki) Kinematic Motion Planning Example

To learn more, look through our documentation/Wiki 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. ;)

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 support for abstract output ports?
  • 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 details


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-0.3.3.tar.gz (78.9 kB view details)

Uploaded Source

Built Distribution

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

brom_drake-0.3.3-py3-none-any.whl (133.7 kB view details)

Uploaded Python 3

File details

Details for the file brom_drake-0.3.3.tar.gz.

File metadata

  • Download URL: brom_drake-0.3.3.tar.gz
  • Upload date:
  • Size: 78.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for brom_drake-0.3.3.tar.gz
Algorithm Hash digest
SHA256 91bfe6fcb4b1e37f14865cba6c0881fa5bb44ecdc44e799a4d9acc8f7219325a
MD5 08ec32344bb02885848b827ccee31836
BLAKE2b-256 f9dec30f60987a2cf479201d34f860c0850995009006bf4d2ed4b08e6bafa5a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for brom_drake-0.3.3.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-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: brom_drake-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 133.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for brom_drake-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9796771b956f6d7ac4ab4e97eefb10d534a4ac1beed01e8f6e82ed63801438ac
MD5 c07d2ed9263d8ecc0d9166eacb041fb9
BLAKE2b-256 ac318a26e6c4c1e20a781e81595f4ffb80784486f234cbbc5ef92f352caa5593

See more details on using hashes here.

Provenance

The following attestation bundles were made for brom_drake-0.3.3-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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page