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 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 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, local eval run, migration, and launch operator 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.0.tar.gz (147.4 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.0-py3-none-any.whl (146.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: roborank-0.1.0.tar.gz
  • Upload date:
  • Size: 147.4 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.0.tar.gz
Algorithm Hash digest
SHA256 3dbfef7fc0a896f3cf6c83ab1350507110ffbdb7e18befdc91db60a18b4ffb6d
MD5 5e4481c92261588300db44d5f8ee05ae
BLAKE2b-256 5696d1070079d5d8049bf397479ff3a6566a75a89cc57b92743af5594f3ecc2b

See more details on using hashes here.

Provenance

The following attestation bundles were made for roborank-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: roborank-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 146.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1b658d48b852634354f59098763bcd52d89cdb7a5a9950fd292f63f1c4adae5
MD5 bfecc4b56fd41b794f112fd02b45a776
BLAKE2b-256 90cfcee3968533d274564e466696b5510c63495a8c240eeaa5ef2a1307e588d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for roborank-0.1.0-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