README.md

Momentum

Momentum provides foundational algorithms for human kinematic motion and numerical optimization solvers to apply human motion in various applications.

Quick Start

Installation

Pre-built binaries are available for Windows, macOS, and Linux:

# Python (PyPI)
pip install pymomentum-cpu      # CPU version
pip install pymomentum-gpu      # GPU version with CUDA

# Python (Conda/Pixi)
pixi add pymomentum             # Auto-detects GPU/CPU
conda install -c conda-forge pymomentum

# C++ (Conda/Pixi only)
pixi add momentum-cpp
conda install -c conda-forge momentum-cpp

📦 Browse packages: PyPI • conda-forge • prefix.dev

Quick Example

# Install and run
pip install pymomentum-cpu
python -c "import pymomentum.geometry as geom; print(dir(geom))"

Building from Source

git clone https://github.com/facebookresearch/momentum
cd momentum
pixi run build      # Builds C++ library and Python bindings
pixi run test       # Runs tests
pixi run hello_world  # Runs example

For detailed instructions, see the comprehensive guides on our website:

• 📘 Python Getting Started - Installation, building from source, troubleshooting
• 📗 C++ Getting Started - Full build instructions, FBX support, examples

📖 Documentation

Visit our documentation website for comprehensive guides, examples, and API references:

• 🐍 Python API Reference - Complete Python API documentation
• ⚙️ C++ API Reference - Complete C++ API documentation

Contributing

Check our contributing guide to learn about how to contribute to the project.

License

Momentum is licensed under the MIT License. A copy of the license can be found here.