Metadata-Version: 2.5
Name: creature-lab
Version: 0.4.1
Summary: Shove a real robot, see exactly why it fell, and prove the fix: a browser app and CLI that check up published robot policies in MuJoCo, plus a workbench for designing modular robots.
Project-URL: Homepage, https://github.com/oney-erge/Creature-Lab
Project-URL: Repository, https://github.com/oney-erge/Creature-Lab
Project-URL: Issues, https://github.com/oney-erge/Creature-Lab/issues
Project-URL: Documentation, https://github.com/oney-erge/Creature-Lab/tree/main/docs
Project-URL: Changelog, https://github.com/oney-erge/Creature-Lab/blob/main/CHANGELOG.md
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: education,humanoid,legged-locomotion,morphology,mujoco,policy-evaluation,push-recovery,pybullet,robot-design,robotics,simulation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: pydantic>=2.7
Requires-Dist: rich>=13.7
Requires-Dist: typer>=0.12
Provides-Extra: app
Requires-Dist: fastapi>=0.115; extra == 'app'
Requires-Dist: imageio-ffmpeg>=0.4; extra == 'app'
Requires-Dist: imageio>=2.31; extra == 'app'
Requires-Dist: matplotlib>=3.8; extra == 'app'
Requires-Dist: mujoco>=3.0; extra == 'app'
Requires-Dist: numpy>=1.26; extra == 'app'
Requires-Dist: onnxruntime>=1.18; extra == 'app'
Requires-Dist: pillow>=10.0; extra == 'app'
Requires-Dist: trimesh>=4.0; extra == 'app'
Requires-Dist: uvicorn>=0.30; extra == 'app'
Requires-Dist: viser>=1.0; extra == 'app'
Provides-Extra: browser
Requires-Dist: playwright>=1.40; extra == 'browser'
Provides-Extra: evolve
Requires-Dist: cmaes>=0.10; extra == 'evolve'
Provides-Extra: export
Requires-Dist: imageio-ffmpeg>=0.4; extra == 'export'
Requires-Dist: imageio>=2.31; extra == 'export'
Requires-Dist: pillow>=10.0; extra == 'export'
Provides-Extra: llm
Requires-Dist: litellm>=1.0; extra == 'llm'
Provides-Extra: mujoco
Requires-Dist: mujoco>=3.0; extra == 'mujoco'
Provides-Extra: rl
Requires-Dist: gymnasium>=0.29; extra == 'rl'
Requires-Dist: stable-baselines3>=2.0; extra == 'rl'
Provides-Extra: robots
Requires-Dist: imageio-ffmpeg>=0.4; extra == 'robots'
Requires-Dist: imageio>=2.31; extra == 'robots'
Requires-Dist: mujoco>=3.0; extra == 'robots'
Requires-Dist: numpy>=1.26; extra == 'robots'
Requires-Dist: onnxruntime>=1.18; extra == 'robots'
Requires-Dist: pillow>=10.0; extra == 'robots'
Provides-Extra: sim
Requires-Dist: numpy>=1.26; extra == 'sim'
Requires-Dist: pybullet>=3.2.6; extra == 'sim'
Provides-Extra: viz
Requires-Dist: matplotlib>=3.8; extra == 'viz'
Requires-Dist: numpy>=1.26; extra == 'viz'
Requires-Dist: trimesh>=4.0; extra == 'viz'
Requires-Dist: viser>=1.0; extra == 'viz'
Provides-Extra: web
Requires-Dist: fastapi>=0.115; extra == 'web'
Requires-Dist: uvicorn>=0.30; extra == 'web'
Description-Content-Type: text/markdown

<p align="center">
  <img src="https://raw.githubusercontent.com/oney-erge/Creature-Lab/main/docs/assets/creature-lab-logo.svg" width="96" height="96" alt="Creature Lab logo" />
</p>

<h1 align="center">Creature Lab</h1>

<p align="center"><strong>Stress-test a real robot, see exactly why it fell, and prove the fix.<br />On a laptop, in a browser.</strong></p>

<p align="center">
  <a href="https://github.com/oney-erge/Creature-Lab/actions/workflows/ci.yml"><img src="https://github.com/oney-erge/Creature-Lab/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
  <a href="https://pypi.org/project/creature-lab/"><img src="https://img.shields.io/pypi/v/creature-lab" alt="PyPI version" /></a>
  <img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python 3.11+" />
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="Apache-2.0 license" /></a>
</p>

<p align="center">
  <a href="https://oneyerge.com/media/creature-lab-tour.mp4"><img src="https://raw.githubusercontent.com/oney-erge/Creature-Lab/main/docs/assets/creature-lab-demo.gif" width="800" alt="The Creature Lab app: a Unitree G1 humanoid takes a 150 N shove mid-stride and falls in slow motion while the side panel explains why. One click on 'A gentler shove' runs it again, and the two runs play side by side: at 100 N it keeps walking." /></a>
</p>

<p align="center"><sub>The real app on saved runs: a 150 N shove, why it fell, and one click to try it gentler.
<a href="https://oneyerge.com/media/creature-lab-tour.mp4">Watch the 1-minute tour</a>. Unitree G1 model and policy by Unitree Robotics, BSD 3-Clause. Simulation.</sub></p>

Creature Lab runs published robots with their **real trained walking policies**. It shoves them at
dozens of strengths and moments, walks them over stairs, ramps, rough ground and stepping stones,
and tries a failing motor, late commands, slippery floors, loads and weak batteries. Then it
explains every fall from the recorded
evidence: where the weight went relative to the feet, how fast the feet slid, whether a foot caught
a step or missed a stone, and whether the motors ran out of torque. Change one thing, or swap the
policy, and see whether the fall is fixed. The physics runs on the CPU (MuJoCo). It is a simulation, not
the hardware.

## Try it

```bash
uvx --from "creature-lab[app]" creature-lab      # or: pip install "creature-lab[app]", then creature-lab
```

Or from a clone, which also gives you the classic editor and the tests:

```bash
git clone https://github.com/oney-erge/Creature-Lab.git
cd Creature-Lab
./run.sh            # macOS: ./run.command   Windows: run.bat
```

Either way it installs prebuilt packages only (no compiler, about 300 MB) and opens the app. Press
**Download and check up** on the Unitree G1 and accept its license. On a laptop, the download and a
40-shove check-up took 31 s from an empty cache.

## What you can do

- **Watch a shove in 3D**, slowed down at the shove and the fall. The app draws the floor area that
  holds the robot up and the point where its weight would land.
- **Read why it fell** in plain words, with the numbers behind it.
- **Walk it over uneven ground**: stairs, a ramp, rough ground and stepping stones, sized to the
  robot. A fall there is explained as a toe caught on a step, a foot down a gap or a slope too
  steep.
- **Ask "what if"**: shove from the other side, harder or gentler, on a slippery floor, slower,
  faster or carrying a load. It runs again in about a second and plays beside the original.
- **Compare policies** on the same test. The 29-joint Unitree G1 has two policies trained for
  Creature Lab, one with small shoves and one with strong shoves; the Microduck has Pollen's walk-only
  and walk-and-get-up policies. A robot with more than two lets you pick which to compare.
- **Bring your own robot and policy**: a MuJoCo model, an ONNX policy and a small `robot.toml`
  (`robots validate`, `robots add`; [guide](docs/ROBOT_PACKS.md)) get the same shoves and explanations.
- **Check for regressions** from the command line: `robots compare` says which tests got better or
  worse between two check-ups (`--fail-on-regression` for CI), and `robots card` writes an SVG
  robustness card for a README or model card.
- **Build your own** quadruped, hexapod, worm or humanoid with sliders, and run it.

<p align="center">
  <img src="https://raw.githubusercontent.com/oney-erge/Creature-Lab/main/docs/assets/g1-two-policies.gif" width="720" alt="The Creature Lab app showing the 29-joint Unitree G1 twice, side by side, taking the same 400 N sideways shove at the same moment. The small-shove policy falls at 4.6 s and stays down; the strong-shove policy keeps walking. The panel says the strong-shove policy stayed on its feet." />
</p>

<p align="center"><sub>Same 400 N shove, same moment, two policies trained the same way except for how hard they were shoved in training (simulation). Over eight shoves at 400 N the small-shove policy fell 5 times, the strong-shove policy once. Unitree G1 model: Unitree Robotics, BSD 3-Clause.</sub></p>

<p align="center">
  <img src="https://raw.githubusercontent.com/oney-erge/Creature-Lab/main/docs/assets/g1-terrain.gif" width="720" alt="The Creature Lab app showing the 29-joint Unitree G1 on stairs with 4 cm steps: a toe catches a step and it falls at 2.8 s, and the panel names the step it caught, with the force on the step's edge. Then the G1 on stepping stones 11 cm apart: a foot goes down into a gap and it falls." />
</p>

<p align="center"><sub>Uneven ground (simulation): stairs with 4 cm steps and stepping stones 11 cm apart. Neither of the G1's policies was trained on anything but a flat floor, and both fall on every stair height the check-up tries. Unitree G1 model: Unitree Robotics, BSD 3-Clause.</sub></p>

## From the command line

```bash
uv sync --inexact --extra robots
uv run creature-lab robots checkup unitree-g1     # or: microduck
uv run creature-lab robots compare BEFORE_DIR AFTER_DIR --fail-on-regression
```

A check-up writes an HTML report; add `--film` for a 1080p film. See
[Robot check-up](docs/ROBOT_CHECKUP.md) for the tests, how falls are explained, licenses and limits.

Creature Lab started as a workbench for designing modular robots, and that is still here: a zoo of
working and deliberately broken creatures, a part-by-part build editor with URDF import and export,
root-cause diagnosis, and search for better bodies and gaits (`creature-lab zoo`, `build`,
`autopsy`, `evolve`). PyBullet is optional for these (`uv sync --inexact --extra sim`); outside
Linux it is built from source and needs a C++ compiler, so the launcher leaves it out and MuJoCo is
used instead.

## What it is not

A teaching and prototyping tool, not hardware qualification, a cloud service or large-scale GPU
training. Check-ups are deterministic simulations of published models; a robot that passes here can
still fall on a real floor.

## Documentation

| Guide | Use it for |
|---|---|
| [Browser app](docs/WEB_APP.md) | Robots, replays, "what if" and check-ups in the app |
| [Robot check-up](docs/ROBOT_CHECKUP.md) | The tests, how falls are explained, licenses |
| [Getting started](docs/GETTING_STARTED.md) | A first experiment, and troubleshooting |
| [CLI reference](docs/CLI_REFERENCE.md) | Every command and export |
| [Known issues](docs/KNOWN_ISSUES.md) | Current limitations |
| [All documentation](docs/README.md) | Build editor, zoo, failure lab, schemas, contributing |

If the launcher fails, it prints what to do; `uv run creature-lab doctor` checks the setup. Docker
serves the same app on localhost: `./run.sh docker`.

Apache-2.0. Built by [Oney Erge](https://oneyerge.com).
