Skip to content

fix: g1 readme and mypy#2113

Merged
paul-nechifor merged 1 commit into
mainfrom
paul/fix/readme2
May 20, 2026
Merged

fix: g1 readme and mypy#2113
paul-nechifor merged 1 commit into
mainfrom
paul/fix/readme2

Conversation

@paul-nechifor
Copy link
Copy Markdown
Contributor

@paul-nechifor paul-nechifor commented May 16, 2026

fix readme and mypy

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 16, 2026

Greptile Summary

This PR fixes the broken dimos --simulation run unitree-g1 CLI command by renaming it to unitree-g1-sim, which matches the registered blueprint key in all_blueprints.py. It also adds a -> None return type to SceneClient.__init__ and suppresses mypy errors for the reportlab package.

  • README.md & docs/quickstart.mdx: Both command tables updated from unitree-g1 to unitree-g1-sim — confirmed to match the entry at line 94 of dimos/robot/all_blueprints.py.
  • scene_client.py: Cosmetic type annotation addition (-> None) on __init__, no behavioral change.
  • pyproject.toml: reportlab and reportlab.* added to mypy's missing-import ignore list, unblocking static analysis.

Confidence Score: 5/5

Safe to merge — all changes are documentation corrections and minor type annotation/config housekeeping with no behavioral risk.

The core fix (renaming unitree-g1 to unitree-g1-sim in docs) is confirmed correct against all_blueprints.py line 94. The scene_client.py change is a purely cosmetic type annotation. The pyproject.toml addition suppresses a mypy import warning for reportlab and poses no runtime risk.

No files require special attention.

Important Files Changed

Filename Overview
README.md Corrects the unitree-g1 command to unitree-g1-sim, matching the registered blueprint name in all_blueprints.py
docs/quickstart.mdx Same command fix as README — updates unitree-g1 to unitree-g1-sim in the quickstart table
dimos/simulation/dimsim/scene_client.py Adds explicit -> None return type annotation to SceneClient.__init__ for type-checker compliance
pyproject.toml Adds reportlab and reportlab.* to mypy's ignore_missing_imports module list, unblocking type checks

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["User runs: dimos --simulation run unitree-g1-sim"] --> B["CLI parses blueprint name"]
    B --> C["all_blueprints.py lookup: 'unitree-g1-sim'"]
    C --> D["dimos.robot.unitree.g1.blueprints.perceptive.unitree_g1_sim:unitree_g1_sim"]
    D --> E["unitree_g1_basic_sim (autoconnect)"]
    E --> F["MuJoCo simulation starts"]

    style A fill:#d4edda,stroke:#28a745
    style C fill:#d4edda,stroke:#28a745
Loading

Reviews (3): Last reviewed commit: "fix: g1 readme and mypy" | Re-trigger Greptile

Comment thread README.md
@codecov
Copy link
Copy Markdown

codecov Bot commented May 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

mustafab0
mustafab0 previously approved these changes May 19, 2026
@paul-nechifor paul-nechifor changed the title fix g1 sim fix: g1 readme and mypy May 19, 2026
@paul-nechifor paul-nechifor enabled auto-merge (squash) May 19, 2026 23:53
@paul-nechifor paul-nechifor merged commit d694dab into main May 20, 2026
31 of 33 checks passed
@paul-nechifor paul-nechifor deleted the paul/fix/readme2 branch May 20, 2026 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants