agx-openplx 0.15.0__cp39-cp39-win_amd64.whl

agx_openplx-0.15.0.dist-info/METADATA

@@ -0,0 +1,232 @@
+Metadata-Version: 2.1
+Name: agx-openplx
+Version: 0.15.0
+Summary: AGX-OpenPLX python interface development
+Home-page: https://pub.algoryx.dev/openplx/
+License: Apache 2.0
+Author: Algoryx
+Author-email: algoryx@algoryx.com
+Requires-Python: >=3.8
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Dist: agx (==2.38.0.2)
+Requires-Dist: openplx-bundles (>=0.15.0,<0.16.0)
+Requires-Dist: pclick (>=0.4.1,<0.5.0)
+Description-Content-Type: text/markdown
+
+# AGX OpenPLX
+
+The agx-openplx package implements all OpenPLX bundles such as Physics, Robotics, DriveTrain and Simulation using [AGX Dynamics Real-time multi-body simulation](https://www.algoryx.se/agx-dynamics/).
+The package contains python bindings and native libraries needed to load and run .openplx files.
+
+See [OpenPLX documentation](https://pub.algoryx.dev/openplx/) for more info on OpenPLX.
+
+## Prerequisites
+
+- Python 3.9 on Windows or OSX
+- Python 3.8 on Ubuntu 20.04
+- Python 3.10 on Ubuntu 22.04
+- [AGX Dynamics](https://www.algoryx.se/agx-dynamics/) 2.38.0.2 and an AGX Dynamics License
+
+At [OpenPLX documentation](https://pub.algoryx.dev/openplx/getopenplx/) you can find out which older version of OpenPLX matches which version of AGX.
+
+## Install
+
+To get the version corresponding to your AGX on Windows do:
+
+```bash
+setup_env.bat
+pip install %AGX_DATA_DIR%/agx-pypi
+pip install -U agx-openplx
+```
+
+To get the version corresponding to your AGX on OSX and Linux do:
+
+```bash
+source setup_env.sh
+pip3 install $AGX_DATA_DIR/agx-pypi
+pip3 install -U agx-openplx
+```
+
+## License
+
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Usage Examples
+
+Given the python file and openplx file below, run with:
+
+```bash
+python3 inverted_pendulum.py
+```
+
+To just simulate the openplx file without controllers, do:
+
+```bash
+openplx_view inverted_pendulum.openplx
+```
+
+or `python3 -m openplx.openplx_view inverted_pendulum.openplx`
+
+Store contents below in a new file named `inverted_pendulum.openplx`:
+
+```openplx
+Rod is Physics3D.Bodies.RigidBody:
+    inertia.mass: 10
+    geometry is Physics3D.Charges.Box:
+        size: Math.Vec3.from_xyz(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.from_xyz(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.from_xyz(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`:
+
+```python
+import os
+import signal
+import agxOSG
+import agxSDK
+from openplxbundles 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 openplx import Math, Physics, Physics3D, Signals
+from openplx import InputSignalListener, OutputSignalListener, load_from_file
+
+def file_dir():
+    return os.path.dirname(os.path.abspath(__file__))
+
+def pendulum():
+    return f"{file_dir()}/inverted_pendulum.openplx"
+
+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.from_xyz(0,0,0)
+            cart_velocity = Math.Vec3.from_xyz(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_from_file(simulation(), pendulum(), bundle_path(), "")
+    assembly = result.assembly()
+    openplx_scene = result.scene()
+    # Add a signal listener so that signals are picked up from inputs
+    input_signal_listener = InputSignalListener(assembly)
+    output_signal_listener = OutputSignalListener(assembly, openplx_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 = openplx_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.'))
+```
+

agx_openplx-0.15.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+openplx/__init__.py,sha256=73QPapLJWuj5dEJzFvWM9kWQNZUWYJuUvR_2jvfAbBI,2101
+openplx/_AgxOpenPlxPyApi.cp39-win_amd64.pyd,sha256=B2vaXpde6-mm5SHMUeirG1vq0tPA55S1elo3acJN6dk,6322176
+openplx/_CorePythonSwig.cp39-win_amd64.pyd,sha256=pFlpaW3MzvjPdBTKNRf3ZjZJVFswXy5n57i6SQYsPDE,2550272
+openplx/_DriveTrainSwig.cp39-win_amd64.pyd,sha256=XqyedEtF4h4vx4XWHATPi6C3xasH8DNZ-EoySMUbtFU,2826752
+openplx/_MathSwig.cp39-win_amd64.pyd,sha256=oNdsvsSInHubZFgkTbP5_KiaqznA5ODkP7yhew0r7RQ,1313792
+openplx/_Physics1DSwig.cp39-win_amd64.pyd,sha256=0eVYY5AHtdgAP4SnKBdV9u7bERX3TSGLVUor5Xkh_FE,2173440
+openplx/_Physics3DSwig.cp39-win_amd64.pyd,sha256=M4MHEAtDueI4r0ka1j9eb1_ZgDy-6pt5iXRDcWC-bxU,12642816
+openplx/_PhysicsSwig.cp39-win_amd64.pyd,sha256=zOZcmz6eRQJTOcbPi8uYnpoKIuh-URbj5saNSodTUHE,9691136
+openplx/_RoboticsSwig.cp39-win_amd64.pyd,sha256=xyfczcxwKuuXmEKrZlqQ9wdtn0yINQAchnp3E6LoDq8,5177344
+openplx/_SimulationSwig.cp39-win_amd64.pyd,sha256=5qAYufH7YdfT4x9PsbOvLydU1HYWOnK_JYdnwfDDUD4,632320
+openplx/_TerrainSwig.cp39-win_amd64.pyd,sha256=Cmo6uozx7gGCuQAkbWZBKRNCxFeKXznU_smgdiRXzcc,1536512
+openplx/_UrdfSwig.cp39-win_amd64.pyd,sha256=JM7b4moSJUKAeOiJ0FN39h8zrKaAXAUMh2-NHXH9ycM,698368
+openplx/_VehiclesSwig.cp39-win_amd64.pyd,sha256=q_VGwVFRLfM35oiPeB8OmCF-D3jIYzfw2rENGDKMnaA,3124224
+openplx/_VisualsSwig.cp39-win_amd64.pyd,sha256=75k0ifzbThqsjqsBjfVgkfEOTX7mbc0srzQbGk8x14I,1281024
+openplx/agxtoopenplx.py,sha256=LCt_tm9tffb0aA5ZsVAqvD1w276NKuq2MQ9vOZS1V1I,2477
+openplx/anytoopenplx.py,sha256=ckINLkHMyraBaIhdJfVXcaeVNh6m7BnyEx9or3j7mxo,2318
+openplx/api.py,sha256=XoU3a-t2bNxO71FeBpuGgENsVaR14DrlPpkCE4cJRn8,48252
+openplx/Core.py,sha256=lQcUoerxSC-TjMSjdNFWGjnQ1eQKVpFJhGl0sTlPkE0,277824
+openplx/DriveTrain.py,sha256=e3ntEsPnXXhw3LWqNsP78A5aZaMNwd_jDa9cjShmP_g,427468
+openplx/Math.py,sha256=hi3zI0KfxZNqy8u78nEm55bZGo0ZoWgqA8piOE2e2B8,193933
+openplx/migrate.py,sha256=SzIjugipKu3fLDpaU91Nh3zZ_jh4h-12sO1dsNroxeU,5738
+openplx/migration_hint.py,sha256=JiD5f7DzCVNoN-N_VweRNIKnSmCRqxhRof4QiR-1rEs,617
+openplx/migrations.py,sha256=Rdh3Ebx-XeH-t8gAphcFyIDCADhkeZWTI4vilhxtcjk,15615
+openplx/openplx_application.py,sha256=wDxdFz5MYjobFg0ofTs9yP0ce6uf_gMr33WLz-BBNJI,6479
+openplx/openplx_serialize.py,sha256=0_hKFnBP8IQ4f22vW6RLHRRNxUZVSu21Lcrgy6lbqPc,1491
+openplx/openplx_validate.py,sha256=PgbC1K0OzKC2rknUtqYWXyCca5TKnZdpkg_ZresGvOY,2112
+openplx/openplx_view.py,sha256=4ISYX0FLsEmdUJyXfixAwyXDsvX5xlTKQLCTEmRCKbM,364
+openplx/Physics.py,sha256=uoxRlbDAfIJ-uWtAo3W33VXuv_79ZHco4Nw4KEj6Rl8,1920631
+openplx/Physics1D.py,sha256=zumBcg-GGIW39BXkywKVldM3FtSWhUFX2aLbZFHRahU,352638
+openplx/Physics3D.py,sha256=Zu70VSG1gbmnvageGT07xIQXXMmNvuICkCfpM0e_Y8I,2480375
+openplx/Robotics.py,sha256=gaq0xM3ZuhvIINeoKP14xENZqTw_B5px_gh40-m-_mI,814741
+openplx/Simulation.py,sha256=xab3Q6-d90xNuPk--zjTB-XO8BNEv48equ_Ms48PLf8,47374
+openplx/Terrain.py,sha256=RhhE6CboZ88n5CbHlyhLzG78vwpjY1sViGgpg7HHuyU,188775
+openplx/Urdf.py,sha256=Z9Q5dKrSPIEgXS9JE7cYKl4zgkhbrdlmV3vBcORE0KY,24434
+openplx/Vehicles.py,sha256=ljYCuwGfA-qqQywHdcI530mIzqIq1DNgb1_d2Jmo5_4,458867
+openplx/versionaction.py,sha256=u0rZ34x1-KtLHM93OBN2BsFAxEAv6HDLadvu14en5io,294
+openplx/Visuals.py,sha256=xTDmvGIxyJPWSgH20CWwQRPDHwOFp48nBl8fo8sN0JY,190953
+agx_openplx-0.15.0.dist-info/entry_points.txt,sha256=IyHBVBNuH_4ZhfWnB1ZVXYtpKG_QT7dwGIUMLWdyhrc,263
+agx_openplx-0.15.0.dist-info/METADATA,sha256=jfj2qYgTFOln0NfOb8u1GhFRNu6UvU-XO-bQtL3_IjU,7875
+agx_openplx-0.15.0.dist-info/WHEEL,sha256=T7hzPzFWHJiWCVylm2UCj5payilA7ulisMC0IiBEe3o,96
+agx_openplx-0.15.0.dist-info/RECORD,,

agx_openplx-0.15.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: false
+Tag: cp39-cp39-win_amd64

agx_openplx-0.15.0.dist-info/entry_points.txt

@@ -0,0 +1,8 @@
+[console_scripts]
+agxtoopenplx=openplx.agxtoopenplx:run
+anytoopenplx=openplx.anytoopenplx:run
+openplx_migrate=openplx.migrate:run
+openplx_serialize=openplx.openplx_serialize:run
+openplx_validate=openplx.openplx_validate:run
+openplx_view=openplx.openplx_view:run
+