Skip to main content

Basic infrastructure for working with robots in COMPAS.

Project description

COMPAS Robots

Made with COMPAS PyPI License: MIT

Robot models and visualization for the COMPAS framework.

Features

  • Load and build robot models from URDF files or programmatically
  • Visualize robots in Rhino, Grasshopper, Blender, and the COMPAS Viewer
  • Forward kinematics and configuration management
  • Load geometry from local files or directly from GitHub repositories
  • Attach tools and meshes to robot links

Installation

pip install compas_robots

Quick start

import math
from compas_robots import RobotModel
from compas_viewer import Viewer

model = RobotModel.ur5e(load_geometry=True)

config = model.zero_configuration()
config["shoulder_lift_joint"] = -math.pi / 2
config["elbow_joint"]         =  math.pi / 2
config["wrist_1_joint"]       = -math.pi / 2
config["wrist_2_joint"]       = -math.pi / 2

viewer = Viewer()
scene_object = viewer.scene.add(model)
scene_object.update(config)
viewer.show()

Loading robot models

From a URDF file:

from compas_robots import RobotModel

model = RobotModel.from_urdf_file("ur5e.urdf")

From a GitHub repository:

from compas_robots import RobotModel
from compas_robots.resources import GithubPackageMeshLoader

github = GithubPackageMeshLoader("ros-industrial/abb", "abb_irb6600_support", "kinetic-devel")
model = RobotModel.from_urdf_file(github.load_urdf("irb6640.urdf"))
model.load_geometry(github)

Documentation

Full documentation, tutorials, and examples at compas.dev/compas_robots.

Contributing

Setup

git clone https://github.com/compas-dev/compas_robots
cd compas_robots
pip install -e ".[dev]"

Code style

invoke lint      # check style
invoke format    # auto-format

Tests

invoke test

Docs

invoke docs

Releases

Releases follow semver:

invoke release minor

License

MIT. See LICENSE.

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

compas_robots-1.0.1.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

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

compas_robots-1.0.1-py3-none-any.whl (6.1 MB view details)

Uploaded Python 3

File details

Details for the file compas_robots-1.0.1.tar.gz.

File metadata

  • Download URL: compas_robots-1.0.1.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for compas_robots-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5e3cdfc2f3e0ab00789f782ab9192b75dabbc031c542347958e6a96b17ca858b
MD5 cd1194653d14762cc8aae6699207064b
BLAKE2b-256 baf797b7e5b87b25931dc6d3e603c0af50ffd19fbaa2074b73b7bfca88aca853

See more details on using hashes here.

File details

Details for the file compas_robots-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: compas_robots-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for compas_robots-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9fe956d5fabccc1760be356e99a6019929326af23598d6312dca907e8677c20
MD5 ed3c60c8a41e8d48b6891d88bbe7a712
BLAKE2b-256 1b906331e22189043fff683d883c587acc4187fe84319786a2ae7858dc9f796b

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