Install

Requirements

• Python 3.11 or newer.
• Linux, macOS, or Windows — the simulo package itself is a thin, torch-free client. It never imports torch or the simulation engine; those live only inside the Simulo runtime that executes your job.

Install

pip install simulo

This installs the torch-free simulo client plus its direct runtime dependencies:

• simulo — the SDK and CLI you use directly: simulo.App, simulo.Runtime, simulo.Volume, simulo.Asset, the @app.job / @app.entrypoint decorators, and the simulo command.
• simulo-interfaces — a torch-free contract layer simulo depends on. Pip resolves and installs it automatically; you never install it yourself.
• mcap — the pure-Python MCAP reader the CLI uses to verify downloaded recordings (see Record & inspect MCAP); also handy for reading recordings programmatically yourself.
• defusedxml — hardened local URDF/XML inspection for asset publishing.
• usd-core — simulator-free USD inspection used when packaging USD asset trees. It is tens of megabytes, installed by default since simulo 0.13.1, and lazy-imported only on the USD path.

pip install simulo still does not pull in torch, a simulator, or any GPU dependency — the Simulo runtime ships them in the cloud, and your app’s app.runtime.imports() block (see Create your first app) defers those imports until the job actually runs, on the worker.

Verify

simulo --help

The help output lists the available commands, including simulo install samples. Use simulo install samples --help to inspect its options.

If simulo is not found, confirm your Python’s bin/Scripts directory is on PATH — pip install prints this directory as a warning when it isn’t. pip show -f simulo lists the install location if you need to track it down; add the script directory to PATH and re-open your shell, then re-run simulo --help.

Note

pip install simulo is everything you need for authoring, submission, observation, and USD/URDF asset packaging. There is no GPU runtime to install; your jobs and cloud asset validation run on Simulo’s managed runtime.

Download samples

With Git installed, download the sample collection without signing in:

simulo install samples
cd simulo-samples

Open README.md in that directory to browse the samples. The command creates a normal Git clone with full history.

On client 0.27.0 or newer, choose a different destination or a Git reference:

simulo install samples --directory robotics-examples --ref main

--directory and --ref work independently. The destination must not already exist, and its parent directory must exist. A failed or interrupted clone or checkout leaves the requested destination absent. Use a tag or full commit ID in place of main for a fixed revision; a branch selects its current tip. With --ref, the checkout is detached at the selected commit.

See the install command reference for all options.

Next

Log in to connect the CLI to the Simulo cloud, then choose a validated asset. You can scaffold an app without logging in, but catalog inspection and cloud submission happen in the signed-in workflow.