Skip to main content

Brick.AGX python interface development

Project description

BRICK AGX

The brickagx package implements all Brick bundles such as Physics, Robotics, DriveTrain and Simulation using AGX Dynamics Real-time multi-body simulation. The package contains python bindings and native libraries needed to load and run .brick files.

See BRICK documentation for more info on BRICK.

Prerequisites

  • Python 3.9 on Windows or OSX
  • Python 3.8 on Ubuntu 20.04
  • Python 3.10 on Ubuntu 22.04
  • AGX Dynamics 2.37.2.0 and an AGX Dynamics License

At BRICK documentation you can find out which older version of BRICK matches which version of AGX.

Install

To get the version corresponding to your AGX on Windows do:

setup_env.bat
pip install %AGX_DATA_DIR%/agx-pypi
pip install -U brickagx

To get the version corresponding to your AGX on OSX and Linux do:

source setup_env.sh
pip3 install $AGX_DATA_DIR/agx-pypi
pip3 install -U brickagx

License

Apache License 2.0

Usage Examples

Given the python file and brick file below, run with:

python3 inverted_pendulum.py

To just simulate the brick file without controllers, do:

brickview inverted_pendulum.brick

or python3 -m rebrick.brickview inverted_pendulum.brick

Store contents below in a new file named inverted_pendulum.brick:

Rod is Physics3D.Bodies.RigidBody:
    inertia.mass: 10
    geometry is Physics3D.Charges.Box:
        size: Math.Vec3.fromXYZ(0.1, 0.1, 1)
    arrow is Physics3D.Charges.Box:
        local_transform:
            position.z: 0.5
            rotation: Math.Quat.angleAxis(Math.PI / 4, Math.Vec3.Y_AXIS())
        size: Math.Vec3.fromXYZ(0.071, 0.1, 0.071)
    mate_connector is Physics3D.Charges.MateConnector:
        position.z: -geometry.size.z * 0.7
        main_axis: Math.Vec3.Y_AXIS()
        normal: Math.Vec3.Z_AXIS()

Cart is Physics3D.Bodies.RigidBody:
    inertia.mass: 10
    geometry is Physics3D.Charges.Box:
        size: Math.Vec3.fromXYZ(0.1, 0.1, 0.1)
    connector is Physics3D.Charges.MateConnector:
        main_axis: Math.Vec3.X_AXIS()
        normal: Math.Vec3.Z_AXIS()
    rotated_connector is Physics3D.Charges.MateConnector:
        main_axis: Math.Vec3.Y_AXIS()
        normal: Math.Vec3.Z_AXIS()

PendulumScene is Physics3D.System:
    world_connector is Physics3D.Charges.MateConnector:
        main_axis: Math.Vec3.X_AXIS()
        normal: Math.Vec3.Z_AXIS()

    cart is Cart
    rod is Rod

    prismatic is Physics3D.Interactions.Prismatic:
        charges: [world_connector, cart.connector]

    cart_motor is Physics3D.Interactions.LinearVelocityMotor:
        desired_speed: 0
        charges: prismatic.charges

    hinge is Physics3D.Interactions.Hinge:
        initial_angle: 0
        charges: [cart.rotated_connector, rod.mate_connector]

    motor_input is Physics3D.Signals.LinearVelocityMotorVelocityInput:
        motor: cart_motor
    
    hinge_angle_output is Physics3D.Signals.HingeAngleOutput:
        hinge: hinge
    hinge_angular_velocity_output is Physics3D.Signals.HingeAngularVelocityOutput:
        hinge: hinge
    
    cart_position_output is Physics3D.Signals.RigidBodyPositionOutput:
        rigid_body: cart
    cart_velocity_output is Physics3D.Signals.RigidBodyVelocityOutput:
        rigid_body: cart

Store contents below in a new file named inverted_pendulum.py:

import os
import signal
import agxOSG
import agxSDK
from brickbundles import bundle_path

# Import useful utilities to access the current simulation, graphics root and application
from agxPythonModules.utils.environment import init_app, simulation, root

from rebrick import Math, Physics, Physics3D, Signals
from rebrick import InputSignalListener, OutputSignalListener, load_brick_file

def file_dir():
    return os.path.dirname(os.path.abspath(__file__))

def pendulum():
    return f"{file_dir()}/inverted_pendulum.brick"

# pylint: disable=C0103

class PDController:
    def __init__(self, kp, kd, goal):
        self.kp = kp
        self.kd = kd
        self.goal = goal

    def observe(self, x, xdot):
        error = self.goal - x
        return self.kp * error - self.kd * xdot


class CartController(agxSDK.StepEventListener):
    motor_input: Physics3D.Signals_LinearVelocityMotorVelocityInput
    cart: PDController
    pole: PDController

    def __init__(self, motor_input: Physics3D.Signals_LinearVelocityMotorVelocityInput):
        super().__init__()
        self.motor_input = motor_input
        self.cart = PDController(kp=10, kd=5, goal=0)
        self.pole = PDController(kp=20, kd=5, goal=0)

    def pre(self, time):
        if time == 0.0:
            hinge_angle = 0
            hinge_angular_velocity = 0
            cart_position = Math.Vec3.fromXYZ(0,0,0)
            cart_velocity = Math.Vec3.fromXYZ(0,0,0)
        else:
            signal_values = {signal.source().getName():signal.value().value() for signal in Signals.getOutputSignals()}
            hinge_angle = signal_values["PendulumScene.hinge_angle_output"]
            hinge_angular_velocity = signal_values["PendulumScene.hinge_angular_velocity_output"]
            cart_position = signal_values["PendulumScene.cart_position_output"]
            cart_velocity = signal_values["PendulumScene.cart_velocity_output"]

        u_cart = self.cart.observe(cart_position.x(), cart_velocity.x())
        u_pole = self.pole.observe(hinge_angle, hinge_angular_velocity)

        Signals.sendInputSignal(Physics.Signals_RealInputSignal.create(-u_cart - u_pole, self.motor_input))


def buildScene():

    result = load_brick_file(simulation(), pendulum(), bundle_path(), "")
    assembly = result.assembly()
    brick_scene = result.brick_object()
    # Add a signal listener so that signals are picked up from inputs
    input_signal_listener = InputSignalListener(assembly)
    output_signal_listener = OutputSignalListener(assembly, brick_scene)
    simulation().add(input_signal_listener, InputSignalListener.RECOMMENDED_PRIO)
    simulation().add(output_signal_listener, OutputSignalListener.RECOMMENDED_PRIO)
    simulation().add(assembly.get())
    agxOSG.createVisual(assembly.get(), root())

    motor_input: Physics3D.Signals_LinearVelocityMotorVelocityInput = brick_scene.getDynamic("motor_input").asObject()
    controller = CartController(motor_input)
    simulation().add(controller)


def handler(_, __):
    os._exit(0)

signal.signal(signal.SIGINT, handler)

init = init_app(name=__name__,
                scenes=[(buildScene, '1')],
                autoStepping=True,  # Default: False
                onInitialized=lambda app: print('App successfully initialized.'),
                onShutdown=lambda app: print('App successfully shut down.'))

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

brickagx-0.4.1-cp310-cp310-manylinux_2_35_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.35+ x86-64

brickagx-0.4.1-cp39-cp39-win_amd64.whl (7.7 MB view details)

Uploaded CPython 3.9 Windows x86-64

brickagx-0.4.1-cp39-cp39-macosx_12_0_arm64.whl (11.3 MB view details)

Uploaded CPython 3.9 macOS 12.0+ ARM64

brickagx-0.4.1-cp39-cp39-macosx_11_0_x86_64.whl (11.8 MB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

brickagx-0.4.1-cp38-cp38-manylinux_2_31_x86_64.whl (16.8 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.31+ x86-64

File details

Details for the file brickagx-0.4.1-cp310-cp310-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for brickagx-0.4.1-cp310-cp310-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 a73c81410122b5b1425b92084ced8d1afc674ac90e8fd8a5c1cc9761b9775dea
MD5 f7b7973f483a1bc1d06b4f0f708d4d80
BLAKE2b-256 300ac0b5c1351cb393038d905ff134a3843a30d2d85b8652d2d3c6c1867dbc1a

See more details on using hashes here.

Provenance

File details

Details for the file brickagx-0.4.1-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: brickagx-0.4.1-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 7.7 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.10 Linux/5.4.0-146-generic

File hashes

Hashes for brickagx-0.4.1-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 b423c699b1b13fb3fd5d2cc0ad1d34a6799139de3acf02f0f0a31e20f0f1af65
MD5 6a567e8d33d74dd2fec44ede2d9b858e
BLAKE2b-256 52bb9fcb6a050e1a15066eac562674bfcbf7309b01d62565c36d81073e55e4f3

See more details on using hashes here.

Provenance

File details

Details for the file brickagx-0.4.1-cp39-cp39-macosx_12_0_arm64.whl.

File metadata

  • Download URL: brickagx-0.4.1-cp39-cp39-macosx_12_0_arm64.whl
  • Upload date:
  • Size: 11.3 MB
  • Tags: CPython 3.9, macOS 12.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.10 Linux/5.4.0-146-generic

File hashes

Hashes for brickagx-0.4.1-cp39-cp39-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 ee45161cd3342df27d14238373f55078a557ecf167d234c050d9782590a2ad01
MD5 189eec420ce8de52231422c12d48d134
BLAKE2b-256 f7c7e2a1bea8c6e9d2417474ef2f9fba02ad89c879b5542ce8768e07eaad2530

See more details on using hashes here.

Provenance

File details

Details for the file brickagx-0.4.1-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: brickagx-0.4.1-cp39-cp39-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 11.8 MB
  • Tags: CPython 3.9, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.10 Linux/5.4.0-146-generic

File hashes

Hashes for brickagx-0.4.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 85e65d68d03808ffa9d188425549c76d5c187cc02f6509666809de66d9c88a38
MD5 2f3233285309dc03d04d51f49904d6f6
BLAKE2b-256 a39cdd0d597697a4b242480a2f7cd83b534f67feaa96a947b258aae21cc4dc0d

See more details on using hashes here.

Provenance

File details

Details for the file brickagx-0.4.1-cp38-cp38-manylinux_2_31_x86_64.whl.

File metadata

File hashes

Hashes for brickagx-0.4.1-cp38-cp38-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 1393eed686b9ce8aca464287df85eb83b95e80aa57f8dad222083ee8a3e91bcf
MD5 4b07cfd978038be2572c6afc6aa3152a
BLAKE2b-256 1b96b72f279dd0c458a0faa3f6a6e475ff9ae6b50e5e68dd5b52aa8c4aa1cb4e

See more details on using hashes here.

Provenance

Supported by

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