diff --git a/docs/index.md b/docs/index.md index ccafa25e..bc2b5b1c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -246,4 +246,5 @@ pos = sim.data.states.pos[0, 0] # shape (3,) — position of world 0, drone 0 - [Quick Start](get-started/quick-start.md) — step-by-step walkthrough of the object-oriented API - [Functional API](user-guide/functional-api.md) — JIT compilation, autodiff, and `jax.lax.scan` rollouts - [Examples](examples/index.md) — runnable scripts covering hover, gradients, batched simulation, and more +- [Projects](projects.md) — research and teaching projects built on Crazyflow - [API Reference](api/index.md) — full Python API diff --git a/docs/projects.md b/docs/projects.md new file mode 100644 index 00000000..f109b93d --- /dev/null +++ b/docs/projects.md @@ -0,0 +1,27 @@ +# Projects using Crazyflow + +Research and teaching projects built on Crazyflow. They show how the simulator is used beyond the self-contained [examples](examples/index.md). + +## LSY Drone Racing + +[learnsyslab/lsy_drone_racing](https://github.com/learnsyslab/lsy_drone_racing) + +A course project for developing and evaluating autonomous drone racing algorithms in simulation and on real Crazyflie hardware. Crazyflow simulates the race tracks and is used to test racing controllers before sim-to-real transfer. See the [project documentation](https://learnsyslab.github.io/lsy_drone_racing/) to get started. + +## Crazyflow Experiments + +[learnsyslab/crazyflow_experiments](https://github.com/learnsyslab/crazyflow_experiments) + +The experiment code for the [Crazyflow paper](https://arxiv.org/abs/2606.01478). It covers simulator speed benchmarks, sim-to-real validation, system identification, learned controllers, sampling-based obstacle avoidance, drone racing, and vision policies trained on Gaussian splats. + +## SwarmGPT + +[learnsyslab/swarmGPT](https://github.com/learnsyslab/swarmGPT) + +Combines large language models with safe swarm motion planning to generate synchronized drone choreographies from natural language instructions. Crazyflow simulates the swarm to verify choreographies before deployment. See the [project website](https://utiasdsl.github.io/swarmGPT/) and the [paper](https://ieeexplore.ieee.org/document/11197931/). + +## Crazyflow UWB + +[learnsyslab/crazyflow_uwb](https://github.com/learnsyslab/crazyflow_uwb) + +Simulates ultra-wideband (UWB) positioning as a Crazyflow plugin. A UWB tag measures noisy, biased ranges to a set of anchors and solves them for a position, which the controller then uses in place of the true state. See the [paper](https://arxiv.org/abs/2610.08225). diff --git a/properdocs.yml b/properdocs.yml index cb9a790e..a92f12fc 100644 --- a/properdocs.yml +++ b/properdocs.yml @@ -79,6 +79,7 @@ nav: - MuJoCo Integration: user-guide/mujoco.md - Gymnasium Environments: user-guide/gymnasium-envs.md - Examples: examples/index.md + - Projects: projects.md - API Reference: api/ - Cite: cite.md