Skip to main content

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.

Metadata

Release files for compas-robots 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for compas-robots 1.0.1
File Size Uploaded
compas_robots-1.0.1.tar.gz 6.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for compas-robots 1.0.1
File Interpreter ABI Platform
compas_robots-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 12.1 MB

Release files / compas_robots-1.0.1.tar.gz

Download URL compas_robots-1.0.1.tar.gz
Size 6.0 MB
Tags Source
SHA-256 checksum
How to use checksums
5e3cdfc2f3e0ab00789f782ab9192b75dabbc031c542347958e6a96b17ca858b
BLAKE2b-256 checksum
How to use checksums
baf797b7e5b87b25931dc6d3e603c0af50ffd19fbaa2074b73b7bfca88aca853
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.20

Release files / compas_robots-1.0.1-py3-none-any.whl

Download URL compas_robots-1.0.1-py3-none-any.whl
Size 6.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
d9fe956d5fabccc1760be356e99a6019929326af23598d6312dca907e8677c20
BLAKE2b-256 checksum
How to use checksums
1b906331e22189043fff683d883c587acc4187fe84319786a2ae7858dc9f796b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.20

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release 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