skelarm 0.2.0

A simple dynamics simulator for a configurable planar robot arm.

skelarm

A lightweight, physics-based dynamics simulator for a configurable planar robot arm. skelarm focuses on kinematics and dynamics simulation without collision detection or complex shape rendering, treating the robot as a "skeleton" of links.

Features

• Configurable Robot: Define arbitrary planar robots with custom link lengths, masses, inertias, and centers of mass. Support for TOML configuration files.
• Kinematics:
  • Forward Kinematics (FK) to compute end-effector position from joint displacements.
• Dynamics (Planar, No Gravity):
  • Inverse Dynamics (ID) using Recursive Newton-Euler algorithm.
  • Forward Dynamics (FD) using mass matrix and Coriolis/centrifugal terms.
  • Physics integration using scipy.integrate.solve_ivp.
  • Note: Gravity is explicitly ignored as the robot operates on a horizontal plane.
• Visualization:
  • Static plotting with matplotlib.
  • Interactive GUI visualizer with PyQt6 and joint sliders.
• Quality Assurance: Fully typed, tested with pytest and hypothesis, and linted with ruff.

Getting Started

Prerequisites

• Python 3.12 or higher.
• uv package manager (recommended) or standard pip.

Installation

1. Clone the repository:

   git clone https://github.com/hrshtst/skelarm.git
   cd skelarm
   

2. Install dependencies using uv (Recommended):

   uv sync
   

   Or using make:

   make install
   

   Alternatively, using pip:

   pip install .
   

Usage Examples

TOML Configuration

You can define robot configurations in TOML files. See examples/simple_robot.toml or examples/four_dof_robot.toml.

[[link]]
length = 1.0
mass = 2.0
inertia = 0.5
com = [0.5, 0.0]        # Center of mass [x, y] relative to joint
limits = [-180.0, 180.0]  # Joint limits [min, max] in degrees

[[link]]
length = 0.8
# ...

Load it using Skeleton.from_toml:

from skelarm import Skeleton
skeleton = Skeleton.from_toml("path/to/robot.toml")

4-DOF Simulation Example

Run a dynamic simulation of a 4-DOF robot loaded from a TOML file:

uv run python examples/simulate_four_dof.py

Interactive Visualizer

Launch the PyQt6 GUI to manipulate a 3-link robot arm with sliders:

uv run python examples/interactive_gui.py

Basic Kinematics & Plotting

Run a script that defines a robot, computes its kinematics, and plots it using Matplotlib:

uv run python examples/basic_plotting.py

Dynamics Simulation

You can use the library to simulate robot motion. See src/skelarm/dynamics.py and tests/test_dynamics.py for API usage.

from skelarm import LinkProp, Skeleton, simulate_robot
import numpy as np

# Define a single link
link = LinkProp(length=1.0, m=1.0, i=0.1, rgx=0.5, rgy=0.0, qmin=-np.pi, qmax=np.pi)
skeleton = Skeleton([link])

# Initial state
skeleton.q = np.array([0.0])
skeleton.dq = np.array([0.0])

# Simulation parameters
time_span = (0.0, 1.0)
def control_torques(t, skel):
    return np.array([0.0]) # Zero torque

# Run simulation
times, q_traj, dq_traj = simulate_robot(skeleton, time_span, control_torques)

Running Tests

This project uses pytest for unit testing and hypothesis for property-based testing of physics consistency.

To run the full test suite:

make test
# OR
uv run pytest

To run tests with coverage report:

make test-cov

Development

We use ruff for linting and formatting, and pyright for static type checking.

• Linting: make lint
• Formatting: make format
• Type Checking: make type-check
• Run all checks: make all

Documentation

The project documentation is built using MkDocs.

• Build Documentation: make docs-build
• Serve Documentation Locally: make docs-serve

License

GPLv3

AI Assistance & Development Workflow

This project is developed with the assistance of AI coding agents. The AI is also used to generate commit messages and parts of the documentation, including API and theoretical reference sections.

Workflow:

1. Context & Theory (Human): The maintainer, Hiroshi Atsuta, establishes the project guidance in AGENTS.md and writes the theoretical background implemented as documentation in docs/reference/.
2. Scaffolding (AI): The AI assistant uses these documents and the constraints defined in AGENTS.md to implement code scaffolding and initial logic.
3. Review & Revision (Human): The maintainer reviews, tests, and revises the generated code to ensure quality and correctness. This cycle is repeated during the development.

Responsibility: All responsibilities for the code hosted in this repository lie with the maintainer. The AI serves strictly as an implementation assistant; final architectural decisions and code quality are human-led.

Feedback: If you identify problems, or find code that appears to be unoriginal or rights-protected, please notify the maintainer immediately by filing an issue.

Contributor Policy: External contributors are welcome to use AI tools for assistance, provided they adhere to the same standard of review and responsibility. If you use AI to generate code for a Pull Request, please disclose it in the PR description and ensure you have thoroughly reviewed and tested the code.