Skip to main content

Misc utilities to work with robot model formats

Project description

This is the "Robot Model Tools" Python package.

The modules in the robmodel package represent different aspects of articulated robot models, such as connectivity, numbering scheme of the links, attached frames, geometry, etc.

The rmt package implements a command line program that operates on robot models, such as the URDF or the KinDSL formats. See

rmt --help

for a list of the available sub commands.

You can try the program without installing this repository (although you still need to install the dependencies):

cd src/
./runner.py --help

Code documentation

More information about the packages and the modules of this project is available in the source code.

You can generate e.g. html documentation using pdoc. For example:

cd src/
pdoc --no-show-source -o /tmp/docs/rmt rmt/ robmodel/

Installation

pip install rmt

Alternatively, install from the source tree:

git clone <repo> rmt    # replace <repo> with the right URL
cd rmt/
pip install .

Dependencies

The following libraries are used by this project:

  • kgprim kinematics/geometric primitives

  • NetworkX, for the connectivity model, which is a graph

  • NumPy

Optionally:

  • textX, for the KinDSL format importer

  • PyYAML, to import YAML models

  • Mako, for the export of models to other formats (which involves text generation)

  • PyGraphviz, required only by the DOT file generator command of the rmt tool

Testing

To launch some tests to validate your installation, move to the test/ folder and run

python -m sample_models.ur5
python -m sample_models.hyq

License

© 2019-present, Marco Frigerio

Released under the BSD 3-clause license. See the LICENSE file for additional information.

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

robot_model_tools-0.3.0.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

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

robot_model_tools-0.3.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file robot_model_tools-0.3.0.tar.gz.

File metadata

  • Download URL: robot_model_tools-0.3.0.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for robot_model_tools-0.3.0.tar.gz
Algorithm Hash digest
SHA256 35d7a9f1dc96dff784cf3a0611991e96b4670315d6f1a62f4e029ea4a7b1f43f
MD5 b1e925525f5ed7b23d6ebe237f04cbcb
BLAKE2b-256 1ff9235f239fac6ff1d4812188ec757c36544107795a0e90312484479bcda6bf

See more details on using hashes here.

File details

Details for the file robot_model_tools-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robot_model_tools-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 555aaff9b0cb9efbcda1be42384f0929f0c39181c52c85b54541f880339f36c8
MD5 cf83b72b00d67233df4888102a141752
BLAKE2b-256 e1dbbe273a05c2c73739657fd8c1c6eb0aca04838bf9d14e190f4f00fce49421

See more details on using hashes here.

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