Skip to main content

physical-sandbox

Overlay robots on photos and videos of a real site, at real scale. Fix a site from a single picture (the floor's four corners), put a machine on it, play a robot motion over the picture, and compare two motions with numbers and a replay video. The command is psbx; psbx stage does all of it on one page.

Everything runs on your machine: photos, videos and cut-outs never leave it.

Try it

Five minutes, one photo of your own desk:

  1. Download a motion to play: hf download lerobot/svla_so101_pickplace --repo-type dataset (hf comes with psbx).
  2. Put an A4 sheet on a desk and take a photo of it, desk.jpg.
  3. psbx stage desk.jpg. Drag the four corners onto the sheet's corners, pick A4, press 決定 (Decide). The work folder is desk/, next to the photo.
  4. In the robot step pick physical-sandbox/so101 (it is pulled from the public catalog; the page offers it as that one line only while no machine is cached, otherwise type so101 in the catalog search box and take it from the hits), drag it beside the sheet, press 決定 (Decide). Without the catalog (offline, or a model of your own): psbx stage desk.jpg --machine DIR, where DIR holds the robot's URDF folder, and the robot step lists it.
  5. In the motion step pick svla_so101_pickplace from the list, episode 0: choosing from the list loads the motion (読み込む (Load) is for a path you typed). Press 再生 (Play): the arm moves on your desk. 動画に書き出す (Export video) writes the replay.
  6. In the compare step pick the same dataset, episode 1, as the second motion and press 比べる (Compare): the table of gaps and two shells. 書き出す (Export) writes the report.

The steps are described under Stage.

Install

uv tool install physical-sandbox            # the psbx command, in its own environment
pip install physical-sandbox                # or into a virtualenv of yours (python3 -m venv .venv first)
pip install 'physical-sandbox[sam,mcp]'     # plus SAM 2.1 (cut out objects) and the MCP server (screens in the chat)

From a checkout of this repository:

python3.12 -m venv .venv
.venv/bin/pip install -e .                  # the core: psbx stage, psbx site fit, psbx compare
.venv/bin/pip install -e '.[sam,mcp,dev]'   # plus the extras and what the tests need

Python 3.10 or newer, macOS or Linux. The core includes everything the stage needs, mesh thinning (fast-simplification) among it. The extras: [sam] cuts out fixed objects with SAM 2.1 (ultralytics), [mcp] is the MCP SDK that serves the in-chat screens (psbx mcp), [dev] runs the tests. The replay video is drawn with MuJoCo offscreen: on macOS that works as it is; on a Linux machine without a display set MUJOCO_GL=egl (or osmesa).

Stage

psbx stage desk.jpg

opens one page in your browser with four steps, in this order. A step opens when the one before it is done: the robot step after the floor is decided, the motion and compare steps after a machine is placed.

  1. 床 (Floor). Drag the four corners onto a rectangle on the ground, going round, 1 to 4. Pick the object's size from the menu, or type the lengths of edge 1→2 and edge 2→3 in centimetres. Tick 長さは実測した値 when you measured them. 決定 writes site.json.
  2. ロボット (Robot). Pick a machine: the ones in ~/.cache/physical-sandbox/machines, the ones already pulled from the catalog, and the folders you gave with --machine. The public catalog can be searched and pulled from the page, no account needed; you can also type the path of a URDF. Drag the machine's shell on the floor and set its yaw. 決定 writes scene.json.
  3. 動き (Motion). Pick a motion: a record file (*.record.json) in the work folder, or a LeRobot dataset found under $HF_HOME/hub and $HF_HOME/lerobot/hub (~/.cache/huggingface unless HF_HOME is set) or given with --lerobot, with its episode number; or type a record's path or lerobot:<folder>#<episode>. Choosing from the list loads it (読み込む (Load) reads a typed path); 再生 (Play) draws it over the photo. To move the robot while the motion plays, use the robot step: the shell there follows the motion, and the motion view follows the robot. 動画に書き出す (Export video) writes replay-<label>.mp4 in the work folder, where the label is the record file's name without .record.json (<file>-<motion> when the file holds several motions; <dataset> ep<N> for a LeRobot episode). A record with one device drives the placed machine, and the page says so.
  4. 比べる (Compare). The motion of the step before is A. Pick a second motion B the same way (and, if you like, the しきい値 (threshold) of the grasp, in radians). 比べる (Compare) shows both shells, the tool-tip trails, the line between the two tips and the table of figures; 書き出す (Export) writes compare/<A>-vs-<B>/gaps.json, gaps.csv, gaps.png and replay.mp4, the same files as psbx compare.

The options: --dir DIR is the work folder (default: next to the picture, named after it), --camera side names the camera in the site (default: the one the folder's floor was decided with, else camera), --machine DIR and --lerobot DIR offer a machine folder or a dataset folder (both repeatable), --port fixes the port, --no-browser only prints the address, for a machine you reach over SSH (forward the port).

One folder is one site: a folder fixed on another picture is refused. stage.json in the folder keeps what the page had (the picture, the machine, motions A and B, the grasp threshold), so psbx stage desk/ reopens where you left off.

The page is served on 127.0.0.1 only, at an address with a random token. The photo and the videos never leave your machine; the only network use is the catalog search and pull you ask for. The line at the bottom of the page shows whether psbx login has been run (it only looks at the token file). Searching and pulling the public catalog needs no account, and a kept token also lets you pull your own private items; pushing is psbx push in a terminal. Ctrl-C in the terminal when done.

Fix a site

A site is a JSON file with the camera that took the picture (its lens and where it stands) and the floor, in metres: x forward, y left, z up, the floor at z = 0. The first site comes from four corners of a rectangle on the ground in one picture and the lengths of two of its edges. Further cameras can then be tied to that site through fixed objects both pictures show (physical_sandbox.site.add_camera in Python). The stage's first step writes it; the rest of this section is for when you want only the floor, or no browser.

The rectangle needs real lengths, and a picture cannot give them. The easy way is to put something of a known size on the floor before taking the picture: a sheet of A4 paper on a table (21 × 29.7 cm), a pallet on a factory floor (110 × 110 cm). Tape on the table and a ruler work too. A lane width or a desk width guessed by eye works as well, but then every report says the dimensions are estimated.

psbx site fit photo.jpg --out site.json is the floor step alone: a page with only the floor, and site.json written where you say (press 決定 again after a change to overwrite it; Ctrl-C when done). --camera, --edges 0.6 0.4 (the lengths to start from, in metres), --no-browser and --port 8797 work as on the stage.

From a script

psbx site fit photo.jpg --corners 42,330 120,360 290,272 219.6,257.3 --edges 0.061 0.129 --out site.json

fits the site without the screen, from corners already known in pixels u,v (going round; a corner outside the picture, with a negative u, is fine) and --edges, the lengths of edge 1-2 and edge 2-3 in metres. Add --measured when you measured them. Nobody has confirmed a site made this way, and the file says so. This is what examples/so101-pickplace uses, with corners read off a frame of the dataset.

From Claude Desktop

An AI agent looks at a photo, proposes the floor's four corners and the fixed objects, and a screen inside the chat shows them over the photo. Drag a corner if it is off, press 決定 (Decide), and the site file is written as site.json in the folder the agent was given.

Add this to claude_desktop_config.json (Settings > Developer > Edit Config), with your own paths, and quit and reopen Claude Desktop with Cmd+Q:

{
  "mcpServers": {
    "physical-sandbox": {
      "command": "/path/to/physical-sandbox/.venv/bin/psbx",
      "args": ["mcp"]
    }
  }
}

Needs the [mcp] extra, and [sam] to cut out objects. A site fixed in the chat calls its camera camera unless the agent names another. The display copy of a photo is kept in ~/.cache/physical-sandbox/ (set PS_CACHE_DIR to move it).

SAM's weights (about 80 MB) are downloaded the first time an object is cut out; that is the only time the network is used. To work offline, fetch them ahead of time with psbx fetch-sam (into ~/.cache/physical-sandbox/, or $PS_CACHE_DIR; --dest puts the file elsewhere, for physical_sandbox.objects.sam_segmenter(weights=...)).

Take a machine from the catalog

psbx catalog search arm          # name  version  category  display
psbx pull physical-sandbox/so101 # prints the cache folder
from physical_sandbox import catalog
from physical_sandbox.machine import load_machine

machine = load_machine(catalog.urdf_path(catalog.pull("physical-sandbox/so101")))

Files are checked against the manifest's sha256 and cached under ~/.cache/physical-sandbox/catalog/ ($PS_CACHE_DIR); a second pull of the same version does not touch the network. $PS_CATALOG_URL points at another catalog server.

Get your own machine ready for the catalog

psbx machine init my-arm/     # product.json and profile.json templates beside the URDF
psbx machine check my-arm/    # one line per check: the URDF reads, the meshes are there, the names and
                              # licence are filled in, wheels are continuous joints
psbx machine init statue.glb  # a mesh-only object: object.json (with its unit, m or mm)

The browser draws a display bundle made from the URDF (physical_sandbox.bundle.make_bundle): bundle.json and binary meshes, large meshes thinned to 20,000 triangles. The fields of product.json, profile.json and object.json, and how the SO-101's grasp was measured, are in docs/machines.md. In Claude Desktop the same check is the ps_machine_check tool.

Push to the catalog

psbx push <handle>/my-arm:1 my-arm/              # a machine folder: checked, bundled, uploaded
psbx push <handle>/statue statue.stl             # an object (beside its object.json); version 1, then 2, ...
psbx push <handle>/run-1:1 record.json --public  # a record (schemaVersion 3), published

The first push signs in: it prints a 6-digit code to enter at <PS.com>/vr, and keeps the token in ~/.config/physical-sandbox/ps-com-token.json (mode 0600) until it expires (psbx login does only this step). You push under your own handle, decided once on PS.com at /catalog/me. Everything is private (only you see it) unless you add --public. A version that is already there is refused (taken); without a version, push takes 1, or one more than the highest number there.

A record whose devices name a local machine ("product": "so101") takes that machine along: when <handle>/so101 is not in the catalog, it goes up privately as <handle>/so101:1 from ~/.cache/physical-sandbox/machines/so101/ or --machine-dir DIR (DIR/so101/). When it is there and the files are the same it is used as it is; when they differ, it goes up as the next version. The uploaded record names <handle>/so101:<version>; your file is left as it was. In Claude Desktop, ps_catalog_push does the same (private by default) once psbx login has been run in a terminal.

Compare two motions

psbx compare --site site.json --scene scene.json --camera camera \
  --a demo.record.json --b policy.record.json --video site.mp4 --out out/

writes, into out/:

  • gaps.json and gaps.csv: the site's quality first (its residual in pixels, whether its dimensions are measured or estimated, whether a person confirmed it), then the gaps: the tool tips' distance at the same time (maximum, when, mean), the difference in path shape (time ignored), each joint's gap, the durations, the smoothness (jerk) and the grasps (where the gripper closes through the middle of the range it went through; the threshold used is in the files, and --grip-threshold sets another; a gripper that hardly moved, under 5 % of its joint's range, gets no grasps and a note instead, so its wobble is never counted). What the numbers cannot tell yet is listed with the reason.
  • gaps.png: the tool gap over time.
  • replay.mp4: both machines over the picture as see-through shells, A blue and B orange, with the tool tips' paths.

A motion (--a, --b) is either a recording file, file.record.json or file.record.json#label to pick one motion in it, or one episode of a LeRobot v3 dataset, lerobot:<dataset folder>#<episode>. With a LeRobot A and no --video, the replay is drawn on A's own recording, cut to A's episode; --lerobot-camera side names the dataset's camera when it is not called like the site camera (a site fixed in the chat calls its camera camera).

The scene says where each machine stands on the site. It is a small JSON file next to the site:

{
  "format": "physical-sandbox.scene/1",
  "site": "site",
  "machines": {
    "so101": {"urdf": "robots/so101.urdf", "x": -0.025, "y": 0.251, "yaw": -0.242, "confirmedByPerson": false}
  },
  "records": []
}

site is the site's id, x and y are metres on the site and yaw radians counter-clockwise; the urdf path is relative to the scene's folder. The machine's id (so101) is what a motion drives; a LeRobot motion drives the scene's only machine. To write one from Python:

from physical_sandbox.machine import load_machine
from physical_sandbox.scene import PlacedMachine, Scene, save_scene
from physical_sandbox.site import load_site

urdf = "robots/so101.urdf"
arm = PlacedMachine(load_machine(urdf), urdf, x=-0.025, y=0.251, yaw=-0.242)
save_scene(Scene(load_site("site.json"), {"so101": arm}), "scene.json")

Recordings come from numpy (physical_sandbox.motion.motion_from_numpy, then save_record) or from LeRobot directly. examples/so101-pickplace runs all of this on a real LeRobot dataset: the site from one frame, the arm placed on it, two episodes compared.

In a notebook

The same comparison, on the work folder the stage left, as a Python call: physical_sandbox.compare(folder, a, b) (the motions are written as on the stage, file.record.json, file.record.json#label or lerobot:<dataset>#<n>, and grip_threshold= is the stage's threshold). Its result shows the stage's table when it is the last thing in a cell, and gives the numbers in the forms a notebook wants:

import physical_sandbox as ps

D = "~/.cache/huggingface/lerobot/hub/datasets--lerobot--svla_so101_pickplace/snapshots/<hash>"
gaps = ps.compare("~/Desktop/desk", f"lerobot:{D}#0", f"lerobot:{D}#1")
gaps                  # the stage's table (mm, degrees, seconds), the site line above it
gaps.figure()         # the tool gap over time (what gaps.png draws), a matplotlib Figure
gaps.to_dataframe()   # the rows of gaps.csv as pandas: item, value, unit, at_s, note
gaps.to_dict()        # what gaps.json holds

# One line per comparison makes a table over many episodes:
import pandas as pd
table = pd.DataFrame(ps.compare("~/Desktop/desk", f"lerobot:{D}#0", f"lerobot:{D}#{i}").row() for i in range(1, 50))
table[["b", "tool_deviation.max", "shape_deviation", "duration.b"]]

row() is flat (a, b, then item -> value in metres, radians and seconds). A comparison takes about a second; the stage's video is not made here (export it on the stage, or run psbx compare).

In Claude Desktop

The ps_compare tool opens the same comparison as a screen in the chat: the site's picture with both machines as see-through shells, the tool-tip paths, a slider and a play button, and the table of numbers (click a time to jump there). Its arguments are those of psbx compare (videoCamera for --lerobot-camera, gripThreshold for --grip-threshold); from the chat it opens only local files, rtsp:// cameras and camera numbers. Leave b out to look at one motion alone: the same screen without the gaps between two (it shows the duration and the grasps).

ps_scene_place(siteDir, machine, x, y, yaw, scenePath=None, urdf=None) writes the scene file the screen needs: it puts machine (a catalog ref such as physical-sandbox/so101, pulled if it is not cached, or, with urdf, the id to give that URDF file) at x, y metres and yaw radians on the site in siteDir, into siteDir/scene.json unless scenePath says another file.

License

Apache-2.0. Copyright Atsushi Kojo. The in-chat screens bundle three.js and the MCP Apps SDK; see NOTICE.

Metadata

Release files for physical-sandbox 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for physical-sandbox 0.1.0
File Size Uploaded Provenance Actions
physical_sandbox-0.1.0.tar.gz 549.0 kB Without provenance Details for physical_sandbox-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for physical-sandbox 0.1.0
File Interpreter ABI Platform Actions
physical_sandbox-0.1.0-py3-none-any.whl Python 3 none any Details for physical_sandbox-0.1.0-py3-none-any.whl

Total release size: 1.0 MB

Release files / physical_sandbox-0.1.0.tar.gz

Download URL physical_sandbox-0.1.0.tar.gz
Size 549.0 kB
Tags Source
SHA-256 checksum
How to use checksums
acadc16b6c3dd4080798391d543d93027ec1dd0ef2addcd801721c8def01ad2a
BLAKE2b-256 checksum
How to use checksums
aed5a961d4cef8c63dfc513c601cb99b51d5b8eaa80458b3e4d426e3d1ad7a27
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release files / physical_sandbox-0.1.0-py3-none-any.whl

Download URL physical_sandbox-0.1.0-py3-none-any.whl
Size 478.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89d1f869386e7347b756ef8ac2c303cc87a07db865b4224843fdf79e2d726a35
BLAKE2b-256 checksum
How to use checksums
16f78ddf011144c83ccec6aae3dfe45bcf2f799d6f8bcbc0df5c8a28baa2e9e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Security for physical-sandbox 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page