https://github.com/upkie/new_agent

Template to create new agents and spines for Upkies
https://github.com/upkie/new_agent

legged-robots python robotics simulation wheeled-biped

Last synced: about 2 months ago
JSON representation

Template to create new agents and spines for Upkies

• Host: GitHub
• URL: https://github.com/upkie/new_agent
• Owner: upkie
• License: apache-2.0
• Created: 2023-10-24T15:05:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-19T09:00:09.000Z (over 1 year ago)
• Last Synced: 2025-01-08T16:04:47.783Z (over 1 year ago)
• Topics: legged-robots, python, robotics, simulation, wheeled-biped
• Language: C++
• Homepage:
• Size: 94.7 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# New agent template

[![upkie](https://img.shields.io/badge/upkie-10.0.0-bbaacc)](https://github.com/upkie/upkie/tree/v10.0.0)

Template repository to create new agents for [Upkie](https://github.com/upkie/upkie) wheeled bipeds.

## Getting started

1. Create a new repository from this template

2. Replace `LICENSE` with the license of your choice (the default one is Apache-2.0)

3. Update your project name and dependencies in `pyproject.toml`

4. Rename the `new_agent` directory to your agent's name

5. Replace occurrences of "new\_agent" by this directory name in `pyproject.toml`

6. Implement your agent in this directory

## Usage

This project uses [pixi](https://pixi.sh/latest/#installation) to run tasks:

- Start a simulation: `pixi run simulation`

- Run the agent: `pixi run agent`

You can use the Makefile to deploy the agent to your robot:

1. `make pack_pixi_env` to package the Python environment

2. `make upload` to upload the agent to the robot

3. Log into the robot and go to the agent directory

4. `make unpack_pixi_env` to unpack the Python environment

5. `make run_agent` to run the agent