A comprehensive Python library for generating smooth trajectories and curves with precise control over position, velocity, acceleration, and jerk profiles
Project description
InterpolatePy
Production-ready trajectory planning and interpolation for robotics, animation, and scientific computing.
InterpolatePy provides 20+ algorithms for smooth trajectory generation with precise control over position, velocity, acceleration, and jerk. From cubic splines and B-curves to quaternion interpolation and S-curve motion profiles — everything you need for professional motion control.
⚡ Fast: Optional C++ backend with pybind11; pure-Python fallback uses vectorized NumPy 🎯 Precise: Research-grade algorithms with C² continuity and bounded derivatives 📊 Visual: Built-in plotting for every algorithm 🔧 Complete: Splines, motion profiles, quaternions, and path planning in one library
Installation
pip install InterpolatePy
Requirements: Python ≥3.11, NumPy ≥2.3, SciPy ≥1.16, Matplotlib ≥3.10.5
Development Installation
git clone https://github.com/GiorgioMedico/InterpolatePy.git
cd InterpolatePy
pip install -e '.[all]' # Includes testing and development tools
Quick Start
import numpy as np
import matplotlib.pyplot as plt
from interpolatepy import CubicSpline, DoubleSTrajectory, StateParams, TrajectoryBounds
# Smooth spline through waypoints
t_points = [0.0, 5.0, 10.0, 15.0]
q_points = [0.0, 2.0, -1.0, 3.0]
spline = CubicSpline(t_points, q_points, v0=0.0, vn=0.0)
# Evaluate at any time
position = spline.evaluate(7.5)
velocity = spline.evaluate_velocity(7.5)
acceleration = spline.evaluate_acceleration(7.5)
# Built-in visualization
spline.plot()
# S-curve motion profile (jerk-limited)
state = StateParams(q_0=0.0, q_1=10.0, v_0=0.0, v_1=0.0)
bounds = TrajectoryBounds(v_bound=5.0, a_bound=10.0, j_bound=30.0)
trajectory = DoubleSTrajectory(state, bounds)
print(f"Duration: {trajectory.get_duration():.2f}s")
# Manual plotting (DoubleSTrajectory doesn't have built-in plot method)
t_eval = np.linspace(0, trajectory.get_duration(), 100)
results = [trajectory.evaluate(t) for t in t_eval]
positions = [r[0] for r in results]
velocities = [r[1] for r in results]
plt.figure(figsize=(10, 6))
plt.subplot(2, 1, 1)
plt.plot(t_eval, positions)
plt.ylabel('Position')
plt.title('S-Curve Trajectory')
plt.subplot(2, 1, 2)
plt.plot(t_eval, velocities)
plt.ylabel('Velocity')
plt.xlabel('Time')
plt.show()
Algorithm Overview
| Category | Algorithms | Key Features | Use Cases |
|---|---|---|---|
| 🔵 Splines | Cubic, B-Spline, Smoothing | C² continuity, noise-robust | Waypoint interpolation, curve fitting |
| ⚡ Motion Profiles | S-curves, Trapezoidal, Polynomial | Bounded derivatives, time-optimal | Industrial automation, robotics |
| 🔄 Quaternions | SLERP, SQUAD, Splines | Smooth rotations, no gimbal lock | 3D orientation control, animation |
| 🎯 Path Planning | Linear, Circular, Frenet frames | Geometric primitives, tool orientation | Path following, machining |
📚 Complete Algorithms Reference →
Detailed technical documentation, mathematical foundations, and implementation details for all 22 algorithms
Complete Algorithm List
Spline Interpolation
CubicSpline– Natural cubic splines with boundary conditionsCubicSmoothingSpline– Noise-robust splines with smoothing parameterCubicSplineWithAcceleration1/2– Bounded acceleration constraintsBSpline– General B-spline curves with configurable degreeApproximationBSpline,CubicBSpline,InterpolationBSpline,SmoothingCubicBSpline
Motion Profiles
DoubleSTrajectory– S-curve profiles with bounded jerkTrapezoidalTrajectory– Classic trapezoidal velocity profilesPolynomialTrajectory– 3rd, 5th, 7th order polynomialsLinearPolyParabolicTrajectory– Linear segments with parabolic blends
Quaternion Interpolation
Quaternion– Core quaternion operations with SLERPQuaternionSpline– C²-continuous rotation trajectoriesSquadC2– Enhanced SQUAD with zero-clamped boundariesLogQuaternion– Logarithmic quaternion methods
Path Planning & Utilities
SimpleLinearPath,SimpleCircularPath– 3D geometric primitivesFrenetFrame– Frenet-Serret frame computation along curvesLinearInterpolation– Basic linear interpolationTridiagonalInverse– Efficient tridiagonal system solver
Advanced Examples
Quaternion Rotation Interpolation
import matplotlib.pyplot as plt
from interpolatepy import QuaternionSpline, Quaternion
# Define rotation waypoints
orientations = [
Quaternion.identity(),
Quaternion.from_euler_angles(0.5, 0.3, 0.1),
Quaternion.from_euler_angles(1.0, -0.2, 0.8)
]
times = [0.0, 2.0, 5.0]
# Smooth quaternion trajectory with C² continuity
quat_spline = QuaternionSpline(times, orientations, interpolation_method="squad")
# Evaluate at any time
orientation, segment = quat_spline.interpolate_at_time(3.5)
# For angular velocity, use interpolate_with_velocity
orientation_with_vel, angular_velocity, segment = quat_spline.interpolate_with_velocity(3.5)
# QuaternionSpline doesn't have built-in plotting - manual visualization needed
plt.show()
B-Spline Curve Fitting
import numpy as np
import matplotlib.pyplot as plt
from interpolatepy import CubicSmoothingSpline
# Fit smooth curve to noisy data
t = np.linspace(0, 10, 50)
q = np.sin(t) + 0.1 * np.random.randn(50)
# Use CubicSmoothingSpline with correct parameter name 'mu'
spline = CubicSmoothingSpline(t, q, mu=0.01)
spline.plot()
plt.show()
Industrial Motion Planning
import numpy as np
import matplotlib.pyplot as plt
from interpolatepy import DoubleSTrajectory, StateParams, TrajectoryBounds
# Jerk-limited S-curve for smooth industrial motion
state = StateParams(q_0=0.0, q_1=50.0, v_0=0.0, v_1=0.0)
bounds = TrajectoryBounds(v_bound=10.0, a_bound=5.0, j_bound=2.0)
trajectory = DoubleSTrajectory(state, bounds)
print(f"Duration: {trajectory.get_duration():.2f}s")
# Evaluate trajectory
t_eval = np.linspace(0, trajectory.get_duration(), 1000)
results = [trajectory.evaluate(t) for t in t_eval]
positions = [r[0] for r in results]
velocities = [r[1] for r in results]
# Manual plotting
plt.figure(figsize=(12, 8))
plt.subplot(2, 1, 1)
plt.plot(t_eval, positions)
plt.ylabel('Position')
plt.title('Industrial S-Curve Motion Profile')
plt.grid(True)
plt.subplot(2, 1, 2)
plt.plot(t_eval, velocities)
plt.ylabel('Velocity')
plt.xlabel('Time')
plt.grid(True)
plt.show()
Who Should Use InterpolatePy?
🤖 Robotics Engineers: Motion planning, trajectory optimization, smooth control
🎬 Animation Artists: Smooth keyframe interpolation, camera paths, character motion
🔬 Scientists: Data smoothing, curve fitting, experimental trajectory analysis
🏭 Automation Engineers: Industrial motion control, CNC machining, conveyor systems
Performance & Quality
- Fast: Optional C++ backend (Eigen + pybind11) for maximum performance; pure-Python fallback uses vectorized NumPy
- Reliable: 85%+ test coverage, continuous integration, 142 additional C++ unit tests
- Modern: Python 3.11+, strict typing, dataclass-based APIs
- Research-grade: Peer-reviewed algorithms from robotics literature
C++ Backend:
InterpolatePy includes an optional compiled C++ extension for performance-critical workloads. The API is identical regardless of backend:
import interpolatepy
print(f"C++ backend: {interpolatepy.HAS_CPP}") # True if extension is available
Set INTERPOLATEPY_NO_CPP=1 to force pure-Python mode.
Typical Performance (pure-Python):
- Cubic spline (1000 points): ~1ms
- B-spline evaluation (10k points): ~5ms
- S-curve trajectory planning: ~0.5ms
Development
Development Setup
git clone https://github.com/GiorgioMedico/InterpolatePy.git
cd InterpolatePy
pip install -e '.[all]'
pre-commit install
# Run tests
python -m pytest tests/
# Run tests with coverage
python -m pytest tests/ --cov=interpolatepy --cov-report=html --cov-report=term
# Code quality
ruff format interpolatepy/
ruff check interpolatepy/
mypy interpolatepy/
# Run all pre-commit hooks
pre-commit run --all-files
Contributing
Contributions welcome! Please:
- Fork the repo and create a feature branch
- Install dev dependencies:
pip install -e '.[all]' - Follow existing patterns and add tests
- Run
pre-commit run --all-filesbefore submitting - Open a pull request with clear description
For major changes, open an issue first to discuss the approach.
Support the Project
⭐ Star the repo if InterpolatePy helps your work!
🐛 Report issues on GitHub Issues
💬 Join discussions to share your use cases and feedback
License & Citation
MIT License – Free for commercial and academic use. See LICENSE for details.
If you use InterpolatePy in research, please cite:
@misc{InterpolatePy,
author = {Giorgio Medico},
title = {InterpolatePy: Trajectory Planning and Interpolation for Python},
year = {2025},
url = {https://github.com/GiorgioMedico/InterpolatePy}
}
Academic References
This library implements algorithms from:
Robotics & Trajectory Planning:
- Biagiotti & Melchiorri (2008). Trajectory Planning for Automatic Machines and Robots
- Siciliano et al. (2010). Robotics: Modelling, Planning and Control
Quaternion Interpolation:
- Parker et al. (2023). "Logarithm-Based Methods for Interpolating Quaternion Time Series"
- Wittmann et al. (2023). "Spherical Cubic Blends: C²-Continuous Quaternion Interpolation"
- Dam, E. B., Koch, M., & Lillholm, M. (1998). "Quaternions, Interpolation and Animation"
Built with ❤️ for the robotics and scientific computing community.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file interpolatepy-3.0.0.tar.gz.
File metadata
- Download URL: interpolatepy-3.0.0.tar.gz
- Upload date:
- Size: 394.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3196b44d255bb7943ce087bd0cb0a4feb9e59d513dad3cd893ef38efd2ea350c
|
|
| MD5 |
88715c2abc2b698f112ac1b845aa391f
|
|
| BLAKE2b-256 |
67b0eb4246b6a62ac6e04fe7e1cfa0127bc0b4ffe74d0ec575c090a0d2415342
|
Provenance
The following attestation bundles were made for interpolatepy-3.0.0.tar.gz:
Publisher:
publish.yml on GiorgioMedico/InterpolatePy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
interpolatepy-3.0.0.tar.gz -
Subject digest:
3196b44d255bb7943ce087bd0cb0a4feb9e59d513dad3cd893ef38efd2ea350c - Sigstore transparency entry: 1154431088
- Sigstore integration time:
-
Permalink:
GiorgioMedico/InterpolatePy@a9b8fa1e0b269a88c0b9596288caf89b1de72f33 -
Branch / Tag:
refs/tags/v3.0.0 - Owner: https://github.com/GiorgioMedico
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a9b8fa1e0b269a88c0b9596288caf89b1de72f33 -
Trigger Event:
release
-
Statement type:
File details
Details for the file interpolatepy-3.0.0-py3-none-any.whl.
File metadata
- Download URL: interpolatepy-3.0.0-py3-none-any.whl
- Upload date:
- Size: 117.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60507fd5b77d5848db42144b0c6c19edad984d8a2d88384ede7d2a44ed15bea0
|
|
| MD5 |
f3d89530699892cae84e05360254285e
|
|
| BLAKE2b-256 |
1cb3859241d4e80080b0d2a360c5e9dfb2232b276bb89dd040c252874229f115
|
Provenance
The following attestation bundles were made for interpolatepy-3.0.0-py3-none-any.whl:
Publisher:
publish.yml on GiorgioMedico/InterpolatePy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
interpolatepy-3.0.0-py3-none-any.whl -
Subject digest:
60507fd5b77d5848db42144b0c6c19edad984d8a2d88384ede7d2a44ed15bea0 - Sigstore transparency entry: 1154431091
- Sigstore integration time:
-
Permalink:
GiorgioMedico/InterpolatePy@a9b8fa1e0b269a88c0b9596288caf89b1de72f33 -
Branch / Tag:
refs/tags/v3.0.0 - Owner: https://github.com/GiorgioMedico
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a9b8fa1e0b269a88c0b9596288caf89b1de72f33 -
Trigger Event:
release
-
Statement type: