Skip to main content

Open RoboRank robotics challenge environment catalog.

Project description

RoboRank Envs

Open-source package for RoboRank robotics challenge environments.

This package exposes the RoboRank challenge catalog, policy-facing API, and simulation runners so environments can be validated and run outside the main RoboRank application.

Setup

uv sync
uv run roborank-envs validate
uv run roborank-envs list
ROBORANK_DISABLE_RERUN_EXPORT=1 uv run roborank-envs run diff_drive_reach_target --policy samples/policies/pure_pursuit.py

Public CLI

The PyPI distribution is published as roborank and installs both the public roborank CLI and the lower-level roborank-envs environment runner:

pip install roborank

The public CLI supports hosted RoboRank API workflows and local challenge evaluation:

uv run roborank prime --agent --json
uv run roborank auth login
uv run roborank auth status --json
uv run roborank eval list --json
uv run roborank eval run diff_drive_reach_target --policy-source samples/policies/pure_pursuit.py --out runs/local-001 --json
uv run roborank eval submit diff_drive_reach_target --policy-source robot_policy.py --yes --non-interactive --json

roborank auth login opens the hosted token page, prompts for the generated token, and saves it in the current project at .roborank/auth.json. Later CLI commands load that file automatically when no --token, ROBORANK_TOKEN, or profile token is configured.

roborank prime is intended as the model-facing index for standard RoboRank procedures. It defines resource and eval boundaries, then points agents to the commands they should use to discover canonical IDs, resource README markdown, metrics schemas, and upload steps.

Resource management commands cover the normal read/write loop:

uv run roborank resources search --kind robot --query "flat disk" --json
uv run roborank resources read robot benkant/flat-disk-robot --json
uv run roborank resources readme robot benkant/flat-disk-robot --out README.md
uv run roborank resources create robot benkant/flat-disk-robot --title "Flat Disk Robot" --markdown README.md --yes --non-interactive --json
uv run roborank resources update robot benkant/flat-disk-robot --markdown README.md --yes --non-interactive --json

roborank eval run uses the packaged roborank_envs.runner local execution path. Install the visualization extra when you need upload-ready Rerun .rrd bundles:

uv sync --extra visualization

Use From RoboRank

From the RoboRank backend checkout:

uv sync
uv run python -m app.environment_registry
uv run pytest

The RoboRank backend pins this package by git commit in backend/pyproject.toml and reports the active package version and git SHA from /health and run metadata.

Current Scope

  • .codex/skills/create-challenge/ contains the repo-local challenge authoring skill, including the brief template and authoring spec.
  • src/roborank_envs/catalog.py exposes list_challenges() and get_challenge().
  • src/roborank_envs/catalog_data.json is a snapshot of the current RoboRank challenge catalog.
  • src/roborank_envs/simulation/ contains the environment runners, robot primitives, MuJoCo world builders, rendering helpers, and Rerun export path.
  • src/roborank_envs/policy_api.py and policy_loader.py contain the public policy API and local policy loading helpers.
  • src/roborank_envs/runner.py runs a local policy file against a packaged challenge.
  • src/roborank/cli.py exposes the public RoboRank CLI, including resource, metrics, evidence, hosted eval submit, and local eval run commands.
  • docs/challenges/ carries public-facing challenge docs.
  • samples/policies/ carries sample policies used for parity checks.

Integration Status

The private RoboRank backend can execute submitted policies through this package. The duplicated internal runner code should stay in RoboRank until a canary deploy has proven the package path in production.

Authoring Challenges

Use .codex/skills/create-challenge/SKILL.md as the agent workflow for adding or modifying environments. It points to:

  • .codex/skills/create-challenge/references/challenge-authoring-spec.md
  • .codex/skills/create-challenge/assets/challenge-brief-template.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roborank-0.1.5.tar.gz (177.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

roborank-0.1.5-py3-none-any.whl (117.7 kB view details)

Uploaded Python 3

File details

Details for the file roborank-0.1.5.tar.gz.

File metadata

  • Download URL: roborank-0.1.5.tar.gz
  • Upload date:
  • Size: 177.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for roborank-0.1.5.tar.gz
Algorithm Hash digest
SHA256 394d6b8cfd738d5e9fbc134e2b5a9b0bc3bd27c93e40a2c16ad42c704d265ed2
MD5 720ac67ea025822429f288369c993065
BLAKE2b-256 32f2f75ed820377264ae6190df1ddc5fb1e54a1ca66d1cc66fc5fd9781f677c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for roborank-0.1.5.tar.gz:

Publisher: release.yaml on BenCaunt/RoboRank-envs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file roborank-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: roborank-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 117.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for roborank-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 75cacbe677f13b5cafa6c03546e79bee12c0e861f766a50f69981b2865beb7ea
MD5 fd7581ea955adcc2a1af1c6ef4f0a57c
BLAKE2b-256 da0769b11aacd3a86ca7da9d33a2981fe647dd99a61f1c7899675e424c7fa06a

See more details on using hashes here.

Provenance

The following attestation bundles were made for roborank-0.1.5-py3-none-any.whl:

Publisher: release.yaml on BenCaunt/RoboRank-envs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page