Template repository to create new agents with custom spines for Upkie wheeled bipeds.
If you don't need a custom spine, you can implement your agent in Python directly, as done for instance in the MPC and Pink balancers.
- Create a new repository from this template
- Search for the string "TODO" and update files accordingly
- Replace
LICENSE
with the license of your choice (the default one is Apache-2.0) - Start listing your dependencies in
environment.yaml
- Rename and start implement your agent from
agent.py
- Implement your C++ spines in the
spines
directory
- Install Python packages to a conda environment:
conda env create -f environment.yaml
- Activate conda environment:
conda activate <env_name>
- Run the simulation spine:
make run_bullet_spine
- Build the pi3hat spine locally:
make build
- Upload the full repository (with built spines) to the robot:
make upload
- Run the pi3hat spine:
make run_pi3hat_spine
(on robot) - Run your agent:
python agent.py