dynibo 0.5.2

Tree-structured robot kinematics and dynamics with runtime-size workspace APIs
Documentation
<!-- markdownlint-disable MD033 MD041 -->

<div align="center">

<h1>dynibo</h1>

<p><strong>a fast, reliable and easy to use library for robot kinematics and dynamics</strong></p>

<p>
  <a href="https://dynibo.readthedocs.io/">Documentation</a> &nbsp;&middot;&nbsp;
  <strong>English</strong> | <a href="https://github.com/xiaojie-xue/dynibo/blob/main/README.zh.md">简体中文</a>
</p>

<p>
  <a href="https://github.com/xiaojie-xue/dynibo/actions/workflows/package-ci.yml"><img alt="CI" src="https://github.com/xiaojie-xue/dynibo/actions/workflows/package-ci.yml/badge.svg?branch=main"></a>
  <a href="https://codecov.io/gh/xiaojie-xue/dynibo"><img alt="codecov" src="https://codecov.io/gh/xiaojie-xue/dynibo/branch/main/graph/badge.svg"></a>
  <a href="https://crates.io/crates/dynibo"><img alt="crates.io" src="https://img.shields.io/crates/v/dynibo.svg?color=CE422B&amp;logo=rust&amp;logoColor=white"></a>
  <a href="https://pypi.org/project/dynibo/"><img alt="PyPI" src="https://img.shields.io/pypi/v/dynibo.svg?color=3776AB&amp;logo=python&amp;logoColor=white"></a>
  <a href="https://github.com/xiaojie-xue/dynibo/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
</p>

</div>

`dynibo` is a robot kinematics and dynamics library for controller development.
It supports manipulators, humanoids, and other robots with fixed or floating
bases. It loads robot models from URDF and provides Rust, Python, C, and C++
interfaces.

## Features

### Fast

Dynibo is written in Rust and reuses per-robot storage. After a `Robot` and
output buffers are created, the main kinematics and dynamics routines do not
allocate or resize memory inside the calculation loop.

To put its computation speed in context, we benchmark Dynibo against
[Pinocchio](https://github.com/stack-of-tasks/pinocchio), an open-source library
for robot kinematics and dynamics. The benchmarks use Franka, a fixed-base
manipulator with 7 joints, and unitree G1, a floating-base humanoid with 29 joints.
The table below shows Dynibo's speedup over Pinocchio for each operation.

<table>
  <thead>
    <tr>
      <th rowspan="2">Operation</th>
      <th colspan="2" align="center">Rust</th>
      <th colspan="2" align="center">Python</th>
    </tr>
    <tr>
      <th>Franka</th><th>unitree G1</th>
      <th>Franka</th><th>unitree G1</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Jacobian</td>
      <td align="right">1.61×</td><td align="right">1.78×</td>
      <td align="right">1.26×</td><td align="right">1.40×</td>
    </tr>
    <tr>
      <td>RNEA</td>
      <td align="right">1.72×</td><td align="right">1.80×</td>
      <td align="right">1.19×</td><td align="right">1.56×</td>
    </tr>
    <tr>
      <td>ABA</td>
      <td align="right">1.14×</td><td align="right">1.17×</td>
      <td align="right">1.76×</td><td align="right">1.94×</td>
    </tr>
  </tbody>
</table>

Source code to reproduce these results is available in [`benches/`](benches/).

### Reliable

Dynibo combines maintained fixtures with a seed-reproducible generated-URDF
corpus, covering serial and branched robots, fixed and floating bases, mixed
joint types, external loads, invalid inputs, and repeated workspace use. Results
are checked against finite-difference approximations, consistency relations
between related algorithms, and outputs from an independent Pinocchio oracle.
Separate tests verify allocation-free execution and the installed Rust, Python,
C, and C++ packages. See the
[test architecture](https://github.com/xiaojie-xue/dynibo/blob/main/tests/TESTING.md)
for details.

### Easy to Use

Dynibo's API is built around `Robot`: load a URDF, then call kinematics and
dynamics algorithms. `Robot` manages its internal calculation storage, so
users do not need to create and maintain separate `Model` and `Data` objects.
Rust, Python, C, and C++ interfaces share the same Rust core, making it easy to
integrate Dynibo into projects in different languages.

## Dependencies

The Rust core has two direct runtime dependencies:

- [`nalgebra`]https://nalgebra.rs/ — linear algebra and numerical types
- [`urdf-rs`]https://github.com/openrr/urdf-rs — URDF parsing

Python wheels bundle the native library and require NumPy 1.23 or newer at runtime.

## Quick start

### Rust

Add the Cargo package:

```bash
cargo add dynibo
```

Load a URDF and compute a target-link pose:

```rust
use dynibo::Robot;

fn main() -> dynibo::Result<()> {
    let mut robot = Robot::from_urdf("robot.urdf")?;
    let tool = robot.link_id("tool")?;
    let q = vec![0.0; robot.joint_count()];

    let pose = robot.forward_kinematics(&q, tool)?;
    println!("translation: {}", pose.translation.vector.transpose());
    Ok(())
}
```

### Python

Install the Python package from PyPI:

```bash
python -m pip install dynibo
```

The Python binding owns its reusable native calculation storage:

```python
import numpy as np

from dynibo import Robot

robot = Robot.from_urdf("robot.urdf")
tool = robot.link_id("tool")
q = np.zeros(robot.joint_count)
pose = robot.forward_kinematics(q, tool)
jacobian = np.empty(6 * robot.generalized_count)
robot.jacobian(q, tool, out=jacobian)
print(pose.translation)
```

### C/C++

C and C++ users can download a prebuilt package for Linux, macOS, or Windows
from [GitHub Releases](https://github.com/xiaojie-xue/dynibo/releases), or build
and install the package from source. Prebuilt packages contain the shared
library, C and C++ headers, pkg-config metadata, and a CMake package
configuration. Select the archive matching your operating system and CPU
architecture and verify it against the release's `SHA256SUMS`.

Building from source requires Rust with Cargo and CMake 3.16 or newer:

```bash
cmake -S . -B build/c -DCMAKE_BUILD_TYPE=Release
cmake --build build/c --parallel
cmake --install build/c --prefix /opt/dynibo
```

Use an extracted prebuilt package or a source installation from another CMake
project:

```cmake
find_package(dynibo CONFIG REQUIRED)
target_link_libraries(my_robot PRIVATE dynibo::dynibo)
```

Configure the consumer with `-DCMAKE_PREFIX_PATH` pointing to the extracted
archive directory or the installation prefix. See the
[installation guide](https://github.com/xiaojie-xue/dynibo/blob/main/docs/getting-started/installation.md)
for platform-specific runtime library paths.

## Examples

Complete Rust, Python, C++, and C examples are available in the
[`examples/`](https://github.com/xiaojie-xue/dynibo/tree/main/examples) directory.
Each example exercises all of the main kinematics and dynamics methods.

## Supported models

Dynibo supports both **fixed-base robots** and **floating-base robots**, using
runtime-sized tree URDFs with revolute, continuous, prismatic, and fixed joints.
It rejects invalid topology and reports structured errors for
bad input lengths, model-mismatched handles, and solver failures.

## Testing

```bash
cargo fmt --all -- --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --all-targets --locked
```

Run the complete local Rust, Python, C, and C++ verification suite with the
command below. Pinocchio reference tests are included when Pinocchio is
available through `pkg-config`.

```bash
bash ci/test-all.sh
```

## License

Dynibo code is licensed under
[MIT](https://github.com/xiaojie-xue/dynibo/blob/main/LICENSE).
Bundled robot descriptions retain their
[third-party licenses](https://github.com/xiaojie-xue/dynibo/blob/main/examples/data/README.md),
including Franka's Apache-2.0 license and Unitree's BSD-3-Clause license.

## Contributing

Dynibo is still at an early stage, and contributions are welcome. See
[`CONTRIBUTING.md`](https://github.com/xiaojie-xue/dynibo/blob/main/CONTRIBUTING.md)
for development setup, required checks, and pull request guidelines.

## Citation

If Dynibo is useful in your work, please cite it as:

```bibtex
@software{xue2026dynibo,
  author  = {Xue, Xiaojie},
  title   = {Dynibo: a Fast, Lightweight, and Reliable Robot Kinematics and Dynamics Library},
  year    = {2026},
  url     = {https://github.com/xiaojie-xue/dynibo}
}
```