Skip to main content

Pinker

Build Documentation

Python inverse kinematics for embedded robots.

Pinker is a leaner version of Pink for single-board computers. Two dependencies, one C file, and it takes 5 seconds to build from source on a Raspberry Pi 4. But it doesn't implement collision avoidance.

Installation

You can install the library from PyPI:

pip install pinker

You can also clone the repository and run it locally:

git clone https://github.com/pink-kinematics/pinker.git && cd pinker
uv run examples/g1_com_tracking.py

Usage

Pinker solves differential inverse kinematics by weighted tasks. A task is defined by a residual function $e(q)$ of the robot configuration $q \in \mathcal{C}$ to be driven to zero. For instance, putting a foot position $p_{foot}(q)$ at a given target $p_{foot}^{\star}$ can be described by the position residual:

$$ e(q) = p_{foot}^{\star} - p_{foot}(q) $$

In differential inverse kinematics, we compute a velocity $v \in \mathfrak{c}$ that satisfies the first-order differential equation:

$$ J_e(q) v = \dot{e}(q) = -\alpha e(q) $$

where $J_e(q) := \frac{\partial e}{\partial q}$ is the task Jacobian. We can define multiple tasks, but some of them will come into conflict if they can't be all fully achieved at the same time. Conflicts are resolved by casting all objectives to a common unit, and weighing these normalized objectives relative to each other. We also include configuration and velocity limits, making our overall optimization problem a quadratic program:

$$ \begin{align} \underset{v \in \mathfrak{c}}{\text{minimize}} \ & \sum_{\text{task } e} \Vert J_e(q) v + \alpha e(q) \Vert^2_{W_e} \ \text{subject to} \ & v_{\text{min}}(q) \leq v \leq v_{\text{max}}(q) \end{align} $$

Pinker provides an API to describe the problem as tasks with targets, and automatically build and solve the underlying quadratic program.

Task costs

Here is the example of a biped robot that controls the position and orientation of its base, left and right contact frames. A fourth "posture" task, giving a preferred angle for each joint, is added for regularization:

from pinker.tasks import FrameTask, PostureTask

tasks = {
    "base": FrameTask(
        "base",
        position_cost=1.0,              # [cost] / [m]
        orientation_cost=1.0,           # [cost] / [rad]
    ),
    "left_contact": FrameTask(
        "left_contact",
        position_cost=[0.1, 0.0, 0.1],  # [cost] / [m]
        orientation_cost=0.0,           # [cost] / [rad]
    ),
    "right_contact": FrameTask(
        "right_contact",
        position_cost=[0.1, 0.0, 0.1],  # [cost] / [m]
        orientation_cost=0.0,           # [cost] / [rad]
    ),
    "posture": PostureTask(
        cost=1e-3,                      # [cost] / [rad]
    ),
}

Orientation (similarly position) costs can be scalars or 3D vectors. They specify how much each radian of angular error "costs" in the overall normalized objective. When using 3D vectors, components are weighted anisotropically along each axis of the body frame.

Task targets

Aside from their costs, most tasks take a second set of parameters called target. For example, a frame task aims for a target transform, while a posture task aims for a target configuration vector. Targets are set by the set_target function:

    tasks["posture"].set_target(
        [1.0, 0.0, 0.0, 0.0] +           # floating base quaternion
        [0.0, 0.0, 0.0] +                # floating base position
        [0.0, 0.2, 0.0, 0.0, -0.2, 0.0]  # joint angles
    )

Body tasks can be initialized, for example, from the robot's neutral configuration:

from pinker import Configuration, load_robot_description, solve_ik

robot = load_robot_description("ur3_official_description")
configuration = Configuration(robot.model, robot.data, robot.q0)
for body, task in tasks.items():
    if type(task) is FrameTask:
        task.set_target(configuration.get_transform_frame_to_world(body))

A task can be added to the inverse kinematics once both its cost and target (if applicable) are defined.

Differential inverse kinematics

Pinker solves differential inverse kinematics, meaning it outputs a velocity that steers the robot towards achieving all tasks at best. If we keep integrating that velocity, and task targets don't change over time, we will converge to a stationary configuration:

dt = 6e-3  # [s]
for t in np.arange(0.0, 42.0, dt):
    velocity = solve_ik(configuration, tasks.values(), dt, solver="quadprog")
    configuration.integrate_inplace(velocity, dt)
    time.sleep(dt)

If task targets are continuously updated, there will be no stationary solution to converge to, but the model will keep on tracking each target at best. By default, solve_ik will take into account both joint limits and velocity limits read from the robot model.

Compatibility

Pinker is API-compatible with Pink 4.4.0, with the following exceptions:

  • Default limits live on the configuration, as configuration.default_limits, rather than being cached on the robot model. Add your own, for instance a FloatingBaseVelocityLimit, by appending to that list.
  • Configuration.integrate returns a new Configuration rather than a configuration vector. Its vector is configuration.integrate(v, dt).q.
  • Functions and methods of the kinematics backend follow Python naming, so model.getFrameId is model.get_frame_id and model.lowerPositionLimit is model.lower_position_limit. Model getters raise rather than returning the sentinel index Pinocchio returns when a name is not found.

Pinker is a standalone replacement for Pink where kinematics are carried out by pinker.kinematics, a backend written as a single C extension with a thin Python layer. Tasks, limits, barriers, the Configuration class and solve_ik, is the same as in Pink, and differential IK problems are still solved through qpsolvers.

Examples

The examples/ directory mirrors Pink's examples, ported to the pinker.kinematics backend with Viser visualization. Each one is named <robot>_<task>.py, after the robot description it loads and what it does with it:

pixi run -e examples python examples/ur3_end_effector_tracking.py

Each example can also be run standalone with uv:

uv run examples/ur3_end_effector_tracking.py

Check out the examples directory for more.

Limitations

  • No collision support: Pink's SelfCollisionBarrier is not available, and neither Configuration nor RobotWrapper carries a collision model or collision data. Use Pink if you need collision-avoidance tasks.
  • One visualizer: Pinker works with Viser, which handles both visualization and user inputs. If you would rather use (the older) MeshCat, head over to Pink, which is compatible with it.
  • The pinker.kinematics backend is not type-checked yet: mypy is disabled on it in pyproject.toml. Enabling it is a matter of shipping a _kinematics_c.pyi stub for the C extension, annotating the arrays cached in Model._packed and the optional values the URDF parser reads, then removing the override.

Benchmark

Pinker and Pink were compared in the pinker benchmark, which runs both against the pink motions library of robot trajectories.

Here are the results from running the benchmark on 2026-09-27 (aarch64, commit 67f92080c) comparing pinker 0.1.0-alpha to pink 4.4.0 (pinocchio 4.1.0). QP solver is clarabel, 10 rollouts per scenario. The conclusions are that:

  1. Pinker produces the same IK problems as Pink: ✅ (numerical variations less than 1e-9)
  2. Pinker has the same performance as Pink: ✅ (timings variations less than 3%)

Here are the statistics scenario by scenario:

scenario nv max QP distance IK check Pink step (ms) Pinker step (ms) step var. (%) perf check
edo 6 6e-15 ✅ 1.97 ± 0.01 1.94 ± 0.01 -1.1 ✅
fanuc 6 9e-14 ✅ 2.17 ± 0.01 2.15 ± 0.01 -0.9 ✅
gen2 6 5e-15 ✅ 2.12 ± 0.01 2.10 ± 0.01 -1.0 ✅
gen3 7 1e-14 ✅ 2.16 ± 0.01 2.14 ± 0.01 -1.1 ✅
iiwa14 7 3e-15 ✅ 2.23 ± 0.02 2.21 ± 0.02 -0.8 ✅
panda 9 1e-15 ✅ 2.37 ± 0.01 2.35 ± 0.01 -0.8 ✅
poppy_ergo_jr 6 2e-15 ✅ 1.96 ± 0.01 1.94 ± 0.01 -1.0 ✅
ur10 6 4e-15 ✅ 2.15 ± 0.01 2.13 ± 0.01 -0.8 ✅
ur3 6 3e-15 ✅ 2.14 ± 0.01 2.12 ± 0.01 -0.9 ✅
ur5 6 3e-15 ✅ 2.14 ± 0.01 2.12 ± 0.01 -0.8 ✅
z1 6 2e-14 ✅ 2.14 ± 0.01 2.12 ± 0.01 -0.9 ✅
atlas_drc 36 3e-13 ✅ 3.88 ± 0.02 3.84 ± 0.01 -1.1 ✅
atlas_v4 36 3e-13 ✅ 3.88 ± 0.02 3.85 ± 0.02 -0.7 ✅
draco3 33 5e-14 ✅ 3.71 ± 0.01 3.68 ± 0.01 -0.7 ✅
ergocub 63 1e-14 ✅ 7.71 ± 0.03 7.57 ± 0.03 -1.9 ✅
h1 25 1e-14 ✅ 3.31 ± 0.01 3.31 ± 0.01 +0.0 ✅
icub 38 2e-13 ✅ 4.26 ± 0.01 4.16 ± 0.01 -2.2 ✅
jaxon 44 1e-13 ✅ 4.11 ± 0.01 4.06 ± 0.01 -1.1 ✅
jvrc 50 5e-13 ✅ 4.59 ± 0.01 4.54 ± 0.01 -1.0 ✅
r2 62 2e-14 ✅ 5.65 ± 0.02 5.57 ± 0.02 -1.3 ✅
romeo 67 5e-14 ✅ 5.06 ± 0.03 4.96 ± 0.03 -1.9 ✅
sigmaban 26 6e-14 ✅ 3.01 ± 0.01 3.01 ± 0.01 -0.1 ✅
talos 50 9e-12 ✅ 4.31 ± 0.02 4.27 ± 0.02 -1.0 ✅
valkyrie 65 4e-15 ✅ 5.43 ± 0.03 5.35 ± 0.03 -1.5 ✅
bolt 12 2e-15 ✅ 2.59 ± 0.01 2.61 ± 0.01 +1.0 ✅
cassie 22 3e-15 ✅ 3.32 ± 0.01 3.32 ± 0.01 +0.1 ✅
spryped 14 8e-15 ✅ 2.57 ± 0.01 2.60 ± 0.01 +0.9 ✅

See the readme and data files in the benchmark repository for more details.

Citation

If you use Pinker in your scientific works, please cite it e.g. as follows:

@software{pinker,
  title = {{Pinker: Python inverse kinematics for embedded robots}},
  author = {Caron, Stéphane and De Mont-Marin, Yann and Budhiraja, Rohan and Bang, Seung Hyeon and Domrachev, Ivan and Nedelchev, Simeon and Du, Peter and Escande, Adrien and Vaillant, Joris and Wingo, Bruce and Patapati, Santosh and San José Pro, Daniel and Marticorena Vidal, Nicolas Guillermo},
  license = {Apache-2.0},
  url = {https://github.com/pink-kinematics/pinker},
  version = {0.1.0},
  year = {2026}
}

Don't forget to add yourself to the BibTeX above and to CITATION.cff if you contribute to this repository.

See also

Software:

  • Jink.jl: Julia package for differential multi-task inverse kinematics.
  • mink: differential inverse kinematics in Python, based on the MuJoCo physics engine.
  • Pink: precursor to Pinker based on Pinocchio.
  • Pink motions: library of robot motions that can be used for benchmarking or continuous integration.
  • Pinocchio: C++ rigid body dynamics algorithms library and reference implementation for the C kinematics backend of Pinker.
  • PlaCo: C++ differential multi-task inverse kinematics based on Pinocchio.
  • pymanoid: precursor to Pink and Pinker based on OpenRAVE.
  • TSID: C++ inverse kinematics based on Pinocchio.

Technical notes:

Metadata

Release files for pinker 0.1.0

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

Source distribution (sdist)

Source distribution for pinker 0.1.0
File Size Uploaded
pinker-0.1.0.tar.gz 104.7 kB Details

Release files / pinker-0.1.0.tar.gz

Download URL pinker-0.1.0.tar.gz
Size 104.7 kB
Tags Source
SHA-256 checksum
How to use checksums
49c4a9f1564a6f8e4dc1a01e846949d7f9548449f44ea17f834ff9d69da28eb3
BLAKE2b-256 checksum
How to use checksums
fd76af9d49ac1d4368026e75f8130b71a74e6b8bb417598cc7191001b6ef641f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release history Release notifications | RSS feed

1.0.0

1 release file

This release

0.1.0 This release

1 release file

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