UpstreamDrift: Getting Started
This page publishes the current public install sequence for UpstreamDrift. Commands and prerequisites are copied from the upstream README at commit 4a1c5f43433c (2026-11-16). UpstreamDrift remains the live authority; AffineDrift CI re-checks this page against data/upstreamdrift/install_readme_contract.json.
For scriptable runs without the GUI, see Headless Simulation and Agent Use.
Prerequisites
- Python 3.11 or 3.12. UpstreamDrift declares
requires-python = ">=3.11,<3.13"inpyproject.tomlat the cited commit. - Git. The shared Tools layer at
vendor/ud-toolsis a mandatory submodule; the platform will not import without it. The repository does not use Git LFS. - MATLAB R2023a or later with Simulink and Simscape Multibody β only if you use the historical MATLAB models, not for the Python platform alone.
Standard Install
git clone https://github.com/D-sorganization/UpstreamDrift.git
cd UpstreamDrift
git submodule update --init --recursive vendor/ud-tools
pip install -e ".[dev]"
python scripts/ci/verify_installation.pyOnly vendor/ud-tools is required. Model submodules (opensim-models, myo_sim, human-gazebo) are optional and needed only for experimental OpenSim or MyoSuite work.
Launch the Platform
python launch_upstream_drift.pyThis starts the local API server on port 8000 and opens the web interface. Common variants from the README:
| Command | Opens |
|---|---|
python launch_upstream_drift.py |
Web interface (default) |
python launch_upstream_drift.py --classic |
PyQt6 desktop application |
python launch_upstream_drift.py --api-only |
API server without a UI |
upstream-drift |
Same as launch_upstream_drift.py (console script) |
Mock Engine (Interface Development Only)
To work on UI or API plumbing without loading a physics engine:
pip install -e .
export GOLF_USE_MOCK_ENGINE=1Output is synthetic. Do not treat it as a physics result.
Troubleshooting
If installation fails, follow the upstream installation troubleshooting guide.
Citation
@online{untitled,
author = {},
title = {UpstreamDrift: {Getting} {Started}},
url = {https://affinedrift.com/pages/upstreamdrift-getting-started.html},
langid = {en}
}