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.4.1.tar.gz (108.7 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.4.1-py3-none-any.whl (179.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for brom_drake-0.4.1.tar.gz
Algorithm Hash digest
SHA256 33a3a19dca76a5a44e2a01588b698c161a6a0b35fff19c3375157640d308e701
MD5 948861308937810bb4da6a67a04aab33
BLAKE2b-256 f3a3e184caad6235609dc73eaee6d0dea475308e7fffb0d2e8f5659286614699

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for brom_drake-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4e280b6b9304e52c7833943db81d5138c831f57e58448c51aa8c3e952e2720
MD5 5c7423bcc450b7dc0a74265d25db2de8
BLAKE2b-256 7e27245cc602d961533af5e111a03d4a0958390a56b2f7000a34c46d1b2ff56d

See more details on using hashes here.

Provenance

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