Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

geniesim — Umbrella meta-package 🧞

geniesim is the umbrella distribution for the Genie Sim platform. It ships no code of its own — installing it pulls in every content-bearing peer in one shot, modelled on Isaac Sim's isaacsim umbrella.

License: Mozilla Public License Version 2.0


📦 What's in the box

Tier 1 — always pulled in by pip install -e source/geniesim/:

Peer Role
🧞 geniesim_cli CLI dispatcher — the geniesim console script
🎨 geniesim_assets Sim-ready 3D asset pack (downloaded separately)
🧪 geniesim_benchmark Benchmark tasks + scoring
geniesim_ros Genie Sim RT Engine (ROS 2)

Tier 2 — opt-in via extras (pip install -e "source/geniesim/[<extra>]"):

Peer Extra Why opt-in
🎮 geniesim_teleop [teleop] · [all] VR / Pico device stack — only needed for teleoperation
🏗️ geniesim_generator [generator] · [all] Heavy LLM / ML deps (jax, mitsuba, torch)
🌍 geniesim_world [world] · [all] PanoRecon: CUDA + PyTorch + SHARP + DA360 — own conda env recommended

🛠️ Install

The umbrella is not on PyPI — install from source via the CLI's bootstrap flow:

pip install -e source/geniesim_cli/
geniesim bootstrap                 # installs every tier-1 peer in topological order

Or, if you already have the peers installed and just want the umbrella itself for its dep pin:

pip install -e source/geniesim/          # tier-1 only
pip install -e "source/geniesim/[teleop]"     # + VR / Pico teleop
pip install -e "source/geniesim/[generator]"  # + LLM scene generator
pip install -e "source/geniesim/[world]"      # + panorama → 3D world (heavy CUDA / ML)
pip install -e "source/geniesim/[all]"        # everything

💡 Why a meta-package

So that pip install geniesim (once on PyPI) drops the full SDK in one step, and so that downstream tooling can declare geniesim as a single dependency line. Heavy runtime deps (Isaac Sim, MuJoCo, open3d, …) live in the relevant peer, never here.


🔗 Pointers