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:
Install full conda/pixi packages -- recommended
# Install full python package from pixi, including modules with cpp torch dependencies
pixi add pymomentum
# Install full python package from conda, including modules with cpp torch dependencies
conda install -c conda-forge pymomentum
# Install cpp momentum package from pixi, including modules with cpp torch dependencies
pixi add momentum-cpp
# Install cpp momentum package from conda, including modules with cpp torch dependencies
conda install -c conda-forge momentum-cpp
Install PyPI wheels -- these are experimental ⚠️
# Install core package with NumPy/SciPy and PyTorch dependencies, but no Torch C++ extension modules
pip install pymomentum-core
# Install core package with optional visualization helpers
pip install "pymomentum-core[viser,rerun]"
# Install full package including diff_geometry and differentiable solver modules, linked against CPU PyTorch
pip install pymomentum-cpu
# Install full package including diff_geometry and differentiable solver modules, linked against CUDA PyTorch
pip install "torch>=2.8,<2.9" --index-url https://download.pytorch.org/whl/cu129
pip install pymomentum-gpu
Conda/Pixi currently publish the full PyMomentum package. Use the PyPI core package (since release v0.1.111) when you need a Python install without the Torch C++ extension dependency.
Install exactly one PyPI package for a given environment. The pymomentum-core package includes the NumPy/SciPy modules geometry, solver2, marker_tracking, axel, camera, and renderer, plus the torch-backed Python helper modules torch. The pymomentum-cpu and pymomentum-gpu packages provide differentiable optimization modules diff_geometry and solver, but they must match a supported PyTorch C++ ABI and therefore have stricter PyTorch version constraints.
⚠️ PyPI support is experimental. For the most stable experience, we recommend using Conda or Pixi.
📦 Browse packages: conda-forge • prefix.dev • PyPI
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
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 pymomentum_gpu-0.1.114.post0-cp313-cp313-win_amd64.whl.
File metadata
- Download URL: pymomentum_gpu-0.1.114.post0-cp313-cp313-win_amd64.whl
- Upload date:
- Size: 92.3 MB
- Tags: CPython 3.13, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e71aae243bd969abd1fe7f4849b433697cefa71f0e8cffefca3a302c2831921b
|
|
| MD5 |
f3ac9e7422da17ac47fa9f4551be0cb8
|
|
| BLAKE2b-256 |
e7368bfb71a80896e8921de3e2de3b8a6542dfbca00038a48cb09be21988261c
|
Provenance
The following attestation bundles were made for pymomentum_gpu-0.1.114.post0-cp313-cp313-win_amd64.whl:
Publisher:
publish_to_pypi.yml on facebookresearch/momentum
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymomentum_gpu-0.1.114.post0-cp313-cp313-win_amd64.whl -
Subject digest:
e71aae243bd969abd1fe7f4849b433697cefa71f0e8cffefca3a302c2831921b - Sigstore transparency entry: 2187516327
- Sigstore integration time:
-
Permalink:
facebookresearch/momentum@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Branch / Tag:
refs/tags/v0.1.114 - Owner: https://github.com/facebookresearch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pymomentum_gpu-0.1.114.post0-cp313-cp313-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: pymomentum_gpu-0.1.114.post0-cp313-cp313-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 43.8 MB
- Tags: CPython 3.13, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb90c7e32ad5228d50a70268d653777ff807af29dbbf0c1f2bd08b4784b7639f
|
|
| MD5 |
19d45a02bc4403ed35395f9dff53f78f
|
|
| BLAKE2b-256 |
191cd9f774e076b97253b6263f106430ff3817164023ac1f606b26b29fd1e18f
|
Provenance
The following attestation bundles were made for pymomentum_gpu-0.1.114.post0-cp313-cp313-manylinux_2_28_x86_64.whl:
Publisher:
publish_to_pypi.yml on facebookresearch/momentum
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymomentum_gpu-0.1.114.post0-cp313-cp313-manylinux_2_28_x86_64.whl -
Subject digest:
eb90c7e32ad5228d50a70268d653777ff807af29dbbf0c1f2bd08b4784b7639f - Sigstore transparency entry: 2187516419
- Sigstore integration time:
-
Permalink:
facebookresearch/momentum@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Branch / Tag:
refs/tags/v0.1.114 - Owner: https://github.com/facebookresearch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pymomentum_gpu-0.1.114.post0-cp312-cp312-win_amd64.whl.
File metadata
- Download URL: pymomentum_gpu-0.1.114.post0-cp312-cp312-win_amd64.whl
- Upload date:
- Size: 92.3 MB
- Tags: CPython 3.12, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9880bfb15099d7005008dc55bef016a09d32ba00e51f25ff0c7c846a7401b599
|
|
| MD5 |
9f8930175c2b7ac5af218214b28b2d51
|
|
| BLAKE2b-256 |
c47ac75592d13c23ee2933070ff81a02830398fa36dfe877cf1982f9c02f76ca
|
Provenance
The following attestation bundles were made for pymomentum_gpu-0.1.114.post0-cp312-cp312-win_amd64.whl:
Publisher:
publish_to_pypi.yml on facebookresearch/momentum
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymomentum_gpu-0.1.114.post0-cp312-cp312-win_amd64.whl -
Subject digest:
9880bfb15099d7005008dc55bef016a09d32ba00e51f25ff0c7c846a7401b599 - Sigstore transparency entry: 2187516370
- Sigstore integration time:
-
Permalink:
facebookresearch/momentum@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Branch / Tag:
refs/tags/v0.1.114 - Owner: https://github.com/facebookresearch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pymomentum_gpu-0.1.114.post0-cp312-cp312-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: pymomentum_gpu-0.1.114.post0-cp312-cp312-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 43.8 MB
- Tags: CPython 3.12, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92a323b15cc19abbf58fd0d49a0f4aa9e7433aafd5131f9b81a6c4856f96dbc8
|
|
| MD5 |
a1c91d430483c7b523607e9c7ea36a7b
|
|
| BLAKE2b-256 |
715b82dd3f0700caaab83db2997f6a7d9534dbbc200162014825639f36a5e309
|
Provenance
The following attestation bundles were made for pymomentum_gpu-0.1.114.post0-cp312-cp312-manylinux_2_28_x86_64.whl:
Publisher:
publish_to_pypi.yml on facebookresearch/momentum
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymomentum_gpu-0.1.114.post0-cp312-cp312-manylinux_2_28_x86_64.whl -
Subject digest:
92a323b15cc19abbf58fd0d49a0f4aa9e7433aafd5131f9b81a6c4856f96dbc8 - Sigstore transparency entry: 2187516460
- Sigstore integration time:
-
Permalink:
facebookresearch/momentum@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Branch / Tag:
refs/tags/v0.1.114 - Owner: https://github.com/facebookresearch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@d4583d9c8cc29a4d2754a9b42962d5aa2bff3ff6 -
Trigger Event:
push
-
Statement type:
