jolly-cli 0.1.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/PKG-INFO +50 -15
  2. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/README.md +49 -14
  3. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/THIRD_PARTY_LICENSES.md +7 -7
  4. jolly_cli-0.3.0/docs/assets/jolly-so101-viewer.png +0 -0
  5. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/CLI-Reference.md +6 -2
  6. jolly_cli-0.3.0/docs/wiki/Challenges-and-Benchmarks.md +29 -0
  7. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/Robot-Models-and-Licensing.md +8 -6
  8. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/__init__.py +1 -1
  9. jolly_cli-0.3.0/jolly/assets/robots/so101/CITATION.cff +29 -0
  10. jolly_cli-0.3.0/jolly/assets/robots/so101/LICENSE-APACHE +201 -0
  11. jolly_cli-0.3.0/jolly/assets/robots/so101/SOURCE.md +10 -0
  12. jolly_cli-0.3.0/jolly/assets/robots/so101/UPSTREAM-README.md +45 -0
  13. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/base_motor_holder_so101_v1.stl +0 -0
  14. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/base_so101_v2.stl +0 -0
  15. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/motor_holder_so101_base_v1.stl +0 -0
  16. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/motor_holder_so101_wrist_v1.stl +0 -0
  17. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/moving_jaw_so101_v1.stl +0 -0
  18. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/rotation_pitch_so101_v1.stl +0 -0
  19. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/sts3215_03a_no_horn_v1.stl +0 -0
  20. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/sts3215_03a_v1.stl +0 -0
  21. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/under_arm_so101_v1.stl +0 -0
  22. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/upper_arm_so101_v1.stl +0 -0
  23. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/waveshare_mounting_plate_so101_v2.stl +0 -0
  24. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/wrist_roll_follower_so101_v1.stl +0 -0
  25. jolly_cli-0.3.0/jolly/assets/robots/so101/assets/wrist_roll_pitch_so101_v2.stl +0 -0
  26. jolly_cli-0.3.0/jolly/assets/robots/so101/so101_new_calib.urdf +453 -0
  27. jolly_cli-0.3.0/jolly/benchmark.py +101 -0
  28. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/challenges.py +21 -12
  29. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/cli.py +22 -11
  30. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/models.py +5 -5
  31. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/physics.py +91 -5
  32. jolly_cli-0.3.0/jolly/driver.py +78 -0
  33. jolly_cli-0.3.0/jolly/engine.py +5 -0
  34. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/web/app.py +59 -5
  35. jolly_cli-0.3.0/jolly/web/index.html +58 -0
  36. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/pyproject.toml +2 -2
  37. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/skills/jolly/SKILL.md +8 -4
  38. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/tests/test_cli.py +14 -0
  39. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/tests/test_physics.py +3 -0
  40. jolly_cli-0.3.0/tests/test_randomization.py +64 -0
  41. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/tests/test_web.py +4 -0
  42. jolly_cli-0.1.0/docs/wiki/Challenges-and-Benchmarks.md +0 -22
  43. jolly_cli-0.1.0/jolly/assets/so101.urdf +0 -17
  44. jolly_cli-0.1.0/jolly/benchmark.py +0 -73
  45. jolly_cli-0.1.0/jolly/web/index.html +0 -58
  46. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/.github/workflows/publish-pypi.yml +0 -0
  47. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/.gitignore +0 -0
  48. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/LICENSE-APACHE +0 -0
  49. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/LICENSE-MIT +0 -0
  50. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/SKILL.md +0 -0
  51. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/assets/jolly-terminal-demo.gif +0 -0
  52. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/assets/jolly-terminal-demo.mp4 +0 -0
  53. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/assets/jolly-web-demo.gif +0 -0
  54. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/assets/jolly-web-demo.webm +0 -0
  55. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/Home.md +0 -0
  56. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/Installation.md +0 -0
  57. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/LLM-Agent-Safety.md +0 -0
  58. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/Web-Viewer.md +0 -0
  59. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/docs/wiki/_Sidebar.md +0 -0
  60. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/__main__.py +0 -0
  61. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/assets/__init__.py +0 -0
  62. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/assets/jolly6.urdf +0 -0
  63. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/__init__.py +0 -0
  64. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/errors.py +0 -0
  65. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/scenes.py +0 -0
  66. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/core/store.py +0 -0
  67. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/jolly/web/__init__.py +0 -0
  68. {jolly_cli-0.1.0 → jolly_cli-0.3.0}/tests/test_models.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: jolly-cli
3
- Version: 0.1.0
3
+ Version: 0.3.0
4
4
  Summary: Local, CLI-native robot-arm physics simulation for humans and LLM agents
5
5
  Project-URL: Homepage, https://github.com/TeamAudiyo/Jolly
6
6
  Project-URL: Repository, https://github.com/TeamAudiyo/Jolly
@@ -42,7 +42,7 @@ It uses PyBullet in deterministic direct mode and saves state between commands.
42
42
  Jolly includes two offline robot profiles:
43
43
 
44
44
  - `jolly6`: an original six-axis arm with a parallel gripper.
45
- - `so101`: a lightweight five-axis SO-101 simulation profile with a gripper.
45
+ - `so101`: the official five-axis SO-101 URDF and CAD meshes with a gripper.
46
46
 
47
47
  The package also accepts scenes, challenges, an engine benchmark, a native
48
48
  PyBullet viewer, and an optional local web viewer. No cloud service, MCP server,
@@ -52,9 +52,10 @@ API key, or network connection is required at runtime.
52
52
 
53
53
  ### Local web simulator
54
54
 
55
- ![Jolly local web simulator demo](docs/assets/jolly-web-demo.gif)
55
+ ![Jolly web viewer rendering the official SO-101 CAD model](docs/assets/jolly-so101-viewer.png)
56
56
 
57
- [Watch the WebM recording](docs/assets/jolly-web-demo.webm)
57
+ The viewport above is a real PyBullet render of the official SO-101 CAD meshes.
58
+ It is not a diagram or a hand-drawn robot substitute.
58
59
 
59
60
  ### Terminal-native control
60
61
 
@@ -92,9 +93,9 @@ npx skills add ./skills/jolly
92
93
 
93
94
  ```bash
94
95
  jolly models --json
95
- jolly reset --model jolly6 --scene blocks --json
96
+ jolly reset --model so101 --scene blocks --json
96
97
  jolly state --json
97
- jolly move --joints "0,-25,70,-45,0,0" --gripper 0.0 --json
98
+ jolly move --joints "0,-20,40,-20,0" --gripper 0.0 --json
98
99
  jolly reach --x 0.30 --y 0.10 --z 0.18 --gripper 0.0 --json
99
100
  jolly render
100
101
  jolly challenge list --json
@@ -110,10 +111,15 @@ jolly serve --host 127.0.0.1 --port 8765
110
111
  Open `http://127.0.0.1:8765`. The JSON API documentation is at
111
112
  `http://127.0.0.1:8765/api/docs`.
112
113
 
114
+ The clean web viewer displays the physical PyBullet world. PyBullet's local
115
+ TinyRenderer draws the official SO-101 STL meshes, scene objects, shadows, and
116
+ floor. Drag the viewport to orbit. Scroll to zoom. The viewer has no CDN,
117
+ external 3D service, or proprietary rendering dependency.
118
+
113
119
  Open the native PyBullet window on a machine with a display:
114
120
 
115
121
  ```bash
116
- jolly viewer --model jolly6 --scene blocks
122
+ jolly viewer --model so101 --scene blocks
117
123
  ```
118
124
 
119
125
  ## Command contract
@@ -133,8 +139,8 @@ Important commands:
133
139
  | `jolly render` | Show a Rich status table and terminal stick figure. |
134
140
  | `jolly reset` | Select a model and scene, then home the robot. |
135
141
  | `jolly scene list/load` | Discover and load deterministic scenes. |
136
- | `jolly challenge list/start/status` | Run agent manipulation challenges. |
137
- | `jolly benchmark` | Check robot loading, FK, and scene construction. |
142
+ | `jolly challenge list/start/status` | Run seeded randomized manipulation challenges. |
143
+ | `jolly benchmark [--seed N] [--cases N]` | Run randomized engine checks with reproducible inputs. |
138
144
 
139
145
  Jolly rejects joint-limit violations and unsafe workspace targets. By default,
140
146
  Jolly rolls back a motion that creates a collision. Use `--allow-collision`
@@ -154,9 +160,16 @@ jolly-cli/
154
160
  │ ├── cli.py
155
161
  │ ├── benchmark.py
156
162
  │ ├── challenges.py
163
+ │ ├── driver.py
164
+ │ ├── engine.py
157
165
  │ ├── assets/
158
166
  │ │ ├── jolly6.urdf
159
- │ │ └── so101.urdf
167
+ │ │ └── robots/so101/
168
+ │ │ ├── so101_new_calib.urdf
169
+ │ │ ├── assets/*.stl
170
+ │ │ ├── LICENSE-APACHE
171
+ │ │ ├── CITATION.cff
172
+ │ │ └── SOURCE.md
160
173
  │ ├── core/
161
174
  │ │ ├── physics.py
162
175
  │ │ ├── models.py
@@ -171,15 +184,37 @@ jolly-cli/
171
184
 
172
185
  ## Physics scope
173
186
 
174
- PyBullet performs rigid-body simulation, FK, IK, contact generation, and scene
175
- settling. Jolly uses deterministic state restoration across short CLI processes.
187
+ `JollyEngine` owns state, safety, motion rollback, grasping, rendering, and the
188
+ public simulator contract. `JollyDriver` generates seeded challenge and
189
+ benchmark cases. The project does not depend on Inspect, Inspect AI, or an
190
+ external robotics benchmark driver.
191
+
192
+ PyBullet is the low-level open-source physics backend. It performs rigid-body
193
+ simulation, FK, IK, contact generation, and scene settling. Jolly uses
194
+ deterministic state restoration across short CLI processes.
176
195
  The grasp helper attaches a nearby graspable object while the gripper is closed.
177
196
  This helper makes terminal pick-and-place repeatable. It is not a soft-contact or
178
197
  motor-current model.
179
198
 
180
- The bundled SO-101 profile uses original primitive collision geometry. Its
181
- joint layout and limits derive from Apache-2.0 upstream robot metadata. It does
182
- not include the upstream CAD meshes and does not claim visual hardware fidelity.
199
+ ## Randomized evaluation
200
+
201
+ Every challenge start generates a new target, object layout, or obstacle layout.
202
+ The result includes the seed and full instance so results stay auditable. Omit
203
+ `--seed` for a fresh unpredictable case. Supply a seed to reproduce a failure:
204
+
205
+ ```bash
206
+ jolly challenge start sort-red --seed 42017 --json
207
+ jolly benchmark --seed 42017 --cases 5 --json
208
+ ```
209
+
210
+ The benchmark generates new joint configurations for every robot case and new
211
+ object layouts for every scene case. This prevents a policy from passing only by
212
+ memorizing the original fixed coordinates.
213
+
214
+ The bundled SO-101 model is the official Apache-2.0 new-calibration URDF from
215
+ The Robot Studio. Jolly includes the 13 referenced STL meshes from pinned commit
216
+ `5f6d2b876a53a4872e405b991dd925556c9e38a4`. Jolly keeps the upstream files
217
+ unmodified and includes their license, citation, source record, and README.
183
218
 
184
219
  ## License
185
220
 
@@ -6,7 +6,7 @@ It uses PyBullet in deterministic direct mode and saves state between commands.
6
6
  Jolly includes two offline robot profiles:
7
7
 
8
8
  - `jolly6`: an original six-axis arm with a parallel gripper.
9
- - `so101`: a lightweight five-axis SO-101 simulation profile with a gripper.
9
+ - `so101`: the official five-axis SO-101 URDF and CAD meshes with a gripper.
10
10
 
11
11
  The package also accepts scenes, challenges, an engine benchmark, a native
12
12
  PyBullet viewer, and an optional local web viewer. No cloud service, MCP server,
@@ -16,9 +16,10 @@ API key, or network connection is required at runtime.
16
16
 
17
17
  ### Local web simulator
18
18
 
19
- ![Jolly local web simulator demo](docs/assets/jolly-web-demo.gif)
19
+ ![Jolly web viewer rendering the official SO-101 CAD model](docs/assets/jolly-so101-viewer.png)
20
20
 
21
- [Watch the WebM recording](docs/assets/jolly-web-demo.webm)
21
+ The viewport above is a real PyBullet render of the official SO-101 CAD meshes.
22
+ It is not a diagram or a hand-drawn robot substitute.
22
23
 
23
24
  ### Terminal-native control
24
25
 
@@ -56,9 +57,9 @@ npx skills add ./skills/jolly
56
57
 
57
58
  ```bash
58
59
  jolly models --json
59
- jolly reset --model jolly6 --scene blocks --json
60
+ jolly reset --model so101 --scene blocks --json
60
61
  jolly state --json
61
- jolly move --joints "0,-25,70,-45,0,0" --gripper 0.0 --json
62
+ jolly move --joints "0,-20,40,-20,0" --gripper 0.0 --json
62
63
  jolly reach --x 0.30 --y 0.10 --z 0.18 --gripper 0.0 --json
63
64
  jolly render
64
65
  jolly challenge list --json
@@ -74,10 +75,15 @@ jolly serve --host 127.0.0.1 --port 8765
74
75
  Open `http://127.0.0.1:8765`. The JSON API documentation is at
75
76
  `http://127.0.0.1:8765/api/docs`.
76
77
 
78
+ The clean web viewer displays the physical PyBullet world. PyBullet's local
79
+ TinyRenderer draws the official SO-101 STL meshes, scene objects, shadows, and
80
+ floor. Drag the viewport to orbit. Scroll to zoom. The viewer has no CDN,
81
+ external 3D service, or proprietary rendering dependency.
82
+
77
83
  Open the native PyBullet window on a machine with a display:
78
84
 
79
85
  ```bash
80
- jolly viewer --model jolly6 --scene blocks
86
+ jolly viewer --model so101 --scene blocks
81
87
  ```
82
88
 
83
89
  ## Command contract
@@ -97,8 +103,8 @@ Important commands:
97
103
  | `jolly render` | Show a Rich status table and terminal stick figure. |
98
104
  | `jolly reset` | Select a model and scene, then home the robot. |
99
105
  | `jolly scene list/load` | Discover and load deterministic scenes. |
100
- | `jolly challenge list/start/status` | Run agent manipulation challenges. |
101
- | `jolly benchmark` | Check robot loading, FK, and scene construction. |
106
+ | `jolly challenge list/start/status` | Run seeded randomized manipulation challenges. |
107
+ | `jolly benchmark [--seed N] [--cases N]` | Run randomized engine checks with reproducible inputs. |
102
108
 
103
109
  Jolly rejects joint-limit violations and unsafe workspace targets. By default,
104
110
  Jolly rolls back a motion that creates a collision. Use `--allow-collision`
@@ -118,9 +124,16 @@ jolly-cli/
118
124
  │ ├── cli.py
119
125
  │ ├── benchmark.py
120
126
  │ ├── challenges.py
127
+ │ ├── driver.py
128
+ │ ├── engine.py
121
129
  │ ├── assets/
122
130
  │ │ ├── jolly6.urdf
123
- │ │ └── so101.urdf
131
+ │ │ └── robots/so101/
132
+ │ │ ├── so101_new_calib.urdf
133
+ │ │ ├── assets/*.stl
134
+ │ │ ├── LICENSE-APACHE
135
+ │ │ ├── CITATION.cff
136
+ │ │ └── SOURCE.md
124
137
  │ ├── core/
125
138
  │ │ ├── physics.py
126
139
  │ │ ├── models.py
@@ -135,15 +148,37 @@ jolly-cli/
135
148
 
136
149
  ## Physics scope
137
150
 
138
- PyBullet performs rigid-body simulation, FK, IK, contact generation, and scene
139
- settling. Jolly uses deterministic state restoration across short CLI processes.
151
+ `JollyEngine` owns state, safety, motion rollback, grasping, rendering, and the
152
+ public simulator contract. `JollyDriver` generates seeded challenge and
153
+ benchmark cases. The project does not depend on Inspect, Inspect AI, or an
154
+ external robotics benchmark driver.
155
+
156
+ PyBullet is the low-level open-source physics backend. It performs rigid-body
157
+ simulation, FK, IK, contact generation, and scene settling. Jolly uses
158
+ deterministic state restoration across short CLI processes.
140
159
  The grasp helper attaches a nearby graspable object while the gripper is closed.
141
160
  This helper makes terminal pick-and-place repeatable. It is not a soft-contact or
142
161
  motor-current model.
143
162
 
144
- The bundled SO-101 profile uses original primitive collision geometry. Its
145
- joint layout and limits derive from Apache-2.0 upstream robot metadata. It does
146
- not include the upstream CAD meshes and does not claim visual hardware fidelity.
163
+ ## Randomized evaluation
164
+
165
+ Every challenge start generates a new target, object layout, or obstacle layout.
166
+ The result includes the seed and full instance so results stay auditable. Omit
167
+ `--seed` for a fresh unpredictable case. Supply a seed to reproduce a failure:
168
+
169
+ ```bash
170
+ jolly challenge start sort-red --seed 42017 --json
171
+ jolly benchmark --seed 42017 --cases 5 --json
172
+ ```
173
+
174
+ The benchmark generates new joint configurations for every robot case and new
175
+ object layouts for every scene case. This prevents a policy from passing only by
176
+ memorizing the original fixed coordinates.
177
+
178
+ The bundled SO-101 model is the official Apache-2.0 new-calibration URDF from
179
+ The Robot Studio. Jolly includes the 13 referenced STL meshes from pinned commit
180
+ `5f6d2b876a53a4872e405b991dd925556c9e38a4`. Jolly keeps the upstream files
181
+ unmodified and includes their license, citation, source record, and README.
147
182
 
148
183
  ## License
149
184
 
@@ -9,19 +9,19 @@ binaries.
9
9
  - License: zlib/libpng (`Zlib`)
10
10
  - License text: https://github.com/bulletphysics/bullet3/blob/master/LICENSE.txt
11
11
 
12
- ## SO-ARM100 / SO-101 metadata
12
+ ## SO-ARM100 / SO-101 robot model
13
13
 
14
- The bundled `jolly/assets/so101.urdf` is a modified simulation profile. It uses
15
- original primitive geometry created for Jolly. Joint names, kinematic layout,
16
- selected dimensions, and limits derive from the SO-101 robot description.
14
+ Jolly redistributes the official SO-101 new-calibration URDF and its referenced
15
+ STL meshes without modification. The files are under
16
+ `jolly/assets/robots/so101/`.
17
17
 
18
18
  - Source: https://github.com/TheRobotStudio/SO-ARM100
19
19
  - Pinned source commit: `5f6d2b876a53a4872e405b991dd925556c9e38a4`
20
20
  - Upstream file: `Simulation/SO101/so101_new_calib.urdf`
21
21
  - License: Apache License 2.0
22
- - Modifications: Replaced all CAD meshes with primitive geometry, simplified
23
- origins, changed the gripper to a linear simulation joint, and added a fixed
24
- tool frame for PyBullet IK.
22
+ - Modifications: None to the vendored URDF or STL files. Jolly selects the
23
+ upstream `gripper_frame_link` as its inverse-kinematics end effector and maps
24
+ the normalized CLI gripper value onto the upstream revolute joint limits.
25
25
 
26
26
  The upstream work is titled "Standard Open SO-100 & SO-101 Arms." Its cited
27
27
  authors are Rob Knight, Pepijn Kooijmans, Remi Cadene, Simon Alibert, Michel
@@ -21,11 +21,15 @@ jolly render
21
21
  jolly scene list --json
22
22
  jolly scene load blocks --json
23
23
  jolly challenge list --json
24
- jolly challenge start sort-red --model jolly6 --json
24
+ jolly challenge start sort-red --model jolly6 [--seed N] --json
25
25
  jolly challenge status --json
26
- jolly benchmark --json
26
+ jolly benchmark [--seed N] [--cases 3] --json
27
27
  ```
28
28
 
29
+ Challenge starts use a fresh random seed by default. The JSON response contains
30
+ the seed and generated instance. Supply `--seed N` to replay the exact case.
31
+ The benchmark randomizes every robot and scene check through `JollyDriver`.
32
+
29
33
  ## Viewers
30
34
 
31
35
  ```bash
@@ -0,0 +1,29 @@
1
+ # Challenges and Benchmarks
2
+
3
+ Jolly includes local scene templates:
4
+
5
+ - `empty`: clear workspace for kinematics.
6
+ - `blocks`: three blocks and two target pads.
7
+ - `shelf`: floor-to-shelf manipulation.
8
+ - `obstacles`: collision-aware reaching.
9
+
10
+ Agent challenges include `reach-center`, `sort-red`, `shelf-load`, and
11
+ `obstacle-reach`. `JollyDriver` generates a new target and scene layout for each
12
+ start. Each challenge has a command budget and explicit success metrics.
13
+
14
+ ```bash
15
+ jolly challenge start sort-red --model jolly6 --json
16
+ # Run move and reach commands.
17
+ jolly challenge status --json
18
+ ```
19
+
20
+ The start result contains a generated seed and instance. Use `--seed` to replay
21
+ the exact case.
22
+
23
+ `jolly benchmark --json` checks engine health with randomized joint states and
24
+ scene layouts. Use `--cases` to select cases per model and scene. Use `--seed`
25
+ to replay the exact generated inputs.
26
+
27
+ Jolly uses its own `JollyEngine` and `JollyDriver`. It does not use Inspect,
28
+ Inspect AI, or an external robot benchmark harness. PyBullet remains the local
29
+ open-source rigid-body physics backend.
@@ -7,12 +7,14 @@ URDF uses primitive geometry and ships under `MIT OR Apache-2.0`.
7
7
 
8
8
  ## SO-101 profile
9
9
 
10
- `so101` is a lightweight five-axis simulation profile with a gripper. It uses
11
- original primitive geometry. Joint names, selected dimensions, and kinematic
12
- limits derive from The Robot Studio's Apache-2.0 SO-101 metadata.
13
-
14
- The profile does not include upstream CAD meshes. It does not claim visual
15
- hardware fidelity or endorsement by The Robot Studio or Hugging Face.
10
+ `so101` uses the official five-axis new-calibration URDF and its 13 referenced
11
+ STL meshes. Jolly vendors the unmodified files from pinned commit
12
+ `5f6d2b876a53a4872e405b991dd925556c9e38a4` of The Robot Studio's SO-ARM100
13
+ repository.
14
+
15
+ The upstream model is Apache-2.0. Jolly includes the upstream license,
16
+ `CITATION.cff`, README, and a source record. Jolly does not claim endorsement by
17
+ The Robot Studio or Hugging Face.
16
18
 
17
19
  ## Physics engine
18
20
 
@@ -1,4 +1,4 @@
1
1
  """Jolly robot-arm simulator."""
2
2
 
3
3
  __all__ = ["__version__"]
4
- __version__ = "0.1.0"
4
+ __version__ = "0.3.0"
@@ -0,0 +1,29 @@
1
+ cff-version: 1.2.0
2
+ date-released: 2024
3
+ message: "If you use this hardware, please cite it as below."
4
+ title: "Standard Open SO-100 & SO-101 Arms"
5
+ url: "https://github.com/TheRobotStudio/SO-ARM100"
6
+ address: "Online"
7
+ authors:
8
+ - family-names: "Knight"
9
+ given-names: "Rob"
10
+ - family-names: "Kooijmans"
11
+ given-names: "Pepijn"
12
+ - family-names: "Cadene"
13
+ given-names: "Remi"
14
+ - family-names: "Alibert"
15
+ given-names: "Simon"
16
+ - family-names: "Aractingi"
17
+ given-names: "Michel"
18
+ - family-names: "Aubakirova"
19
+ given-names: "Dana"
20
+ - family-names: "Zouitine"
21
+ given-names: "Adil"
22
+ - family-names: "Martino"
23
+ given-names: "Russi"
24
+ - family-names: "Palma"
25
+ given-names: "Steven"
26
+ - family-names: "Pascal"
27
+ given-names: "Caroline"
28
+ - family-names: Wolf
29
+ given-names: Thomas
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,10 @@
1
+ # Source
2
+
3
+ These unmodified SO-101 simulation assets came from:
4
+
5
+ - Repository: https://github.com/TheRobotStudio/SO-ARM100
6
+ - Commit: `5f6d2b876a53a4872e405b991dd925556c9e38a4`
7
+ - Upstream path: `Simulation/SO101/`
8
+ - License: Apache-2.0
9
+
10
+ The bundled files include the official new-calibration URDF and only the STL meshes referenced by that URDF.
@@ -0,0 +1,45 @@
1
+ # SO101 Robot - URDF and MuJoCo Description
2
+
3
+ This repository contains the URDF and MuJoCo (MJCF) files for the SO101 robot.
4
+
5
+ ## Overview
6
+
7
+ - The robot model files were generated using the [onshape-to-robot](https://github.com/Rhoban/onshape-to-robot) plugin from a CAD model designed in Onshape.
8
+ - The generated URDFs were modified to allow meshes with relative paths instead of `package://...`.
9
+ - Base collision meshes were removed due to problematic collision behavior during simulation and planning.
10
+
11
+ ## Calibration Methods
12
+
13
+ The MuJoCo file `scene.xml` supports two differenly calibrated SO101 robot files:
14
+
15
+ - **New Calibration (Default)**: Each joint's virtual zero is set to the **middle** of its joint range. Use -> `so101_new_calib.xml`.
16
+ - **Old Calibration**: Each joint's virtual zero is set to the configuration where the robot is **fully extended horizontally**. Use -> `so101_old_calib.xml`.
17
+
18
+ To switch between calibration methods, modify the included robot file in `scene.xml`.
19
+
20
+ ## Leader Arm URDF
21
+
22
+ `so101_leader_new_calib.urdf` is a URDF for the **SO-101 leader** (teleoperation) arm, sharing the "new calibration" zero convention above. It reuses the follower's base/shoulder/upper-arm/lower-arm/wrist links and meshes; only the gripper subtree differs: the fixed follower gripper body is replaced by `Wrist_Roll_SO101.stl` and `Handle_SO101.stl`, and the moving jaw by `Trigger_SO101.stl` (meshes converted from `STEP/SO101/Leader_Specific/`). The actuated joint keeps the name `gripper` for compatibility with the other five arm joints.
23
+
24
+ ```bash
25
+ rerun Simulation/SO101/so101_leader_new_calib.urdf
26
+ ```
27
+
28
+ **Calibration caveat:** the five arm joints carry the same calibration as `so101_new_calib.urdf`. The trigger joint's zero, travel limits (provisionally 0–45°) and the printed-part inertia estimates were derived from CAD geometry and a rough average printed-part density, not from a measured leader unit — there is no MJCF/XML counterpart yet.
29
+
30
+ ## Motor Parameters
31
+
32
+ Motor properties for the STS3215 motors used in the robot are adapted from the [Open Duck Mini project](https://github.com/apirrone/Open_Duck_Mini).
33
+
34
+ ## Gripper Note
35
+
36
+ In LeRobot, the gripper is represented as a **linear joint**, where:
37
+
38
+ * `0` = fully closed
39
+ * `100` = fully open
40
+
41
+ This mapping is **not yet reflected** in the current URDF and MuJoCo files.
42
+
43
+ ---
44
+
45
+ Feel free to open an issue or contribute improvements!