sim2sim-onepass 0.1.0__tar.gz

sim2sim_onepass-0.1.0/LICENSE

@@ -0,0 +1,118 @@
+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.
+"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.
+
+"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.
+
+"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.
+
+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.
+
+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.
+
+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.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work 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.
+
+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, 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.
+
+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.
+
+END OF TERMS AND CONDITIONS

sim2sim_onepass-0.1.0/MANIFEST.in

@@ -0,0 +1,18 @@
+include LICENSE
+include README.md
+include QUICKSTART.md
+include REPO_MAP.md
+include RESULTS_SUMMARY.md
+include VISUAL_INDEX.md
+include MANIFEST.md
+include PYPI_PACKAGE_NOTES.md
+recursive-include src/sim2sim_onepass/resources *.md
+
+prune outputs
+prune assets
+prune docs
+prune examples
+prune .git
+
+global-exclude *.py[cod]
+global-exclude __pycache__

sim2sim_onepass-0.1.0/MANIFEST.md

@@ -0,0 +1,40 @@
+# Manifest
+
+This file defines what this curated release intentionally includes and excludes.
+
+## Included In The Curated Release
+
+- [`README.md`](README.md), [`QUICKSTART.md`](QUICKSTART.md), [`REPO_MAP.md`](REPO_MAP.md), [`VISUAL_INDEX.md`](VISUAL_INDEX.md), [`RESULTS_SUMMARY.md`](RESULTS_SUMMARY.md)
+- [`configs/canonical_sources.json`](configs/canonical_sources.json)
+- [`scripts/package_release_assets.py`](scripts/package_release_assets.py)
+- [`examples/canonical_commands.ps1`](examples/canonical_commands.ps1)
+- [`assets/pipeline.pdf`](assets/pipeline.pdf)
+- [`outputs/canonical_pass/report.md`](outputs/canonical_pass/report.md)
+- [`outputs/canonical_pass/metrics_summary.json`](outputs/canonical_pass/metrics_summary.json)
+- copied canonical plots, previews, and videos under [`outputs/canonical_pass/`](outputs/canonical_pass/)
+- copied source reports:
+  - `source_stress_report.md`
+  - `source_stress_metrics.json`
+  - `source_behavioral_report.md`
+  - `source_triptych_report.md`
+
+## Intentionally Excluded From The Curated Layer
+
+- all raw frame dumps from the original report folders
+- most timestamped `reports/` runs that are intermediate, failed, or redundant
+- training logs and exploratory experiments not needed to understand the public claim
+- full paper build artifacts
+- third-party simulator assets and environment internals copied into the release layer
+- debug-only scripts and one-off diagnostics copied into the release layer
+
+## Why These Items Are Canonical
+
+- `reports/stress_20260203-173231` is canonical because it is the clearest documented PASS for the quantitative hard-mode claim.
+- `reports/20260210-173200/behavioral_acceptance` is canonical because it is a clean visual PASS with motion, visibility, rollout-improvement, and acrobatics gates all passing.
+- The copied release assets are small, human-readable, and enough to verify the claim without browsing unrelated history.
+
+## Why The Rest Stays In The Repo
+
+- The original repository still serves as provenance and development history.
+- This release layer does not delete that history; it only controls what a reviewer sees first.
+- Future pruning can happen later, after confirming which historical runs must remain for reproducibility.

sim2sim_onepass-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: sim2sim-onepass
+Version: 0.1.0
+Summary: A lightweight companion package for the Sim2Sim-OnePass public research release.
+Author: ANTHONY-OLEVESTER
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ANTHONY-OLEVESTER/Robotics_sim-to-sim_OnePass
+Project-URL: Repository, https://github.com/ANTHONY-OLEVESTER/Robotics_sim-to-sim_OnePass
+Project-URL: Documentation, https://github.com/ANTHONY-OLEVESTER/Robotics_sim-to-sim_OnePass
+Project-URL: Issues, https://github.com/ANTHONY-OLEVESTER/Robotics_sim-to-sim_OnePass/issues
+Keywords: robotics,simulation,mujoco,pybullet,research
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Provides-Extra: rollout
+Requires-Dist: torch>=2.0; extra == "rollout"
+Provides-Extra: alignment
+Requires-Dist: PyYAML>=6.0; extra == "alignment"
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Dynamic: license-file
+
+# Sim2Sim-OnePass Public Release
+
+This curated layer is the fast path through the repository. It is designed so a new visitor can understand the claim, watch the evidence, inspect the canonical PASS artifacts, and run the shortest validation path without digging through the full development history.
+
+## Companion Package
+
+This branch adds a PyPI-ready package layer named `sim2sim-onepass`. It is a lightweight companion package for the public research release, not a standalone robotics simulator system. It provides an installable CLI, embedded docs access, results navigation, environment checks, and selected lightweight utilities around the curated repo.
+
+Local editable install:
+
+```powershell
+python -m pip install -e .
+```
+
+Published PyPI install:
+
+```powershell
+python -m pip install sim2sim-onepass
+```
+
+PyPI package page:
+
+```text
+https://pypi.org/project/sim2sim-onepass/
+```
+
+CLI entrypoint:
+
+```powershell
+sim2sim-onepass --help
+```
+
+What the package does provide:
+
+- repo navigation and public documentation access
+- embedded lightweight markdown docs
+- environment checking
+- quick sanity checks on paired datasets
+- rollout-check wrapper for model + norm + paired data paths
+- guarded simulator workflow commands with clear errors when the full simulator stack is not present
+
+What the package does not provide by default:
+
+- full simulator environments
+- full datasets
+- giant reports dumps
+- replay videos and large binary outputs
+- local environments and machine-specific folders
+- the full simulator env trees and internal training workspace
+
+## Command Capability Levels
+
+| Command | Category | Requirements |
+| --- | --- | --- |
+| `info` | Standalone | package install only |
+| `quickstart` | Standalone | package install only |
+| `repo-map` | Standalone | package install only |
+| `results-summary` | Standalone | package install only |
+| `visual-index` | Standalone | package install only |
+| `docs` | Standalone | package install only |
+| `check-env` | Standalone | package install only |
+| `quick-sanity` | Dataset-dependent | paired datasets, or `--demo` for the tiny built-in fixture |
+| `rollout-check` | Dataset-dependent | paired datasets, model, norm file, and optional extra `sim2sim-onepass[rollout]` |
+| `alignment-gate` | Full repo / simulator dependent | full curated repo layout plus simulator dependencies |
+| `alignment-report` | Full repo / simulator dependent | full curated repo layout plus simulator dependencies and workflow files |
+
+## Pick Your Route
+
+| If you want to... | Open this |
+| --- | --- |
+| See the project in one screen | [RESULTS_SUMMARY.md](RESULTS_SUMMARY.md) |
+| Watch the visual evidence first | [VISUAL_INDEX.md](VISUAL_INDEX.md) |
+| Run the shortest validation path | [QUICKSTART.md](QUICKSTART.md) |
+| Inspect the packaged PASS bundle | [outputs/canonical_pass/](outputs/canonical_pass/) |
+| Understand how the repo is organized | [REPO_MAP.md](REPO_MAP.md) |
+
+## See It Before You Read It
+
+| Triptych preview | Rollout figure |
+| --- | --- |
+| [![Triptych preview](outputs/canonical_pass/preview/triptych_frame0.png)](outputs/canonical_pass/preview/triptych_frame0.png) | [![Rollout figure](outputs/canonical_pass/plots/rollout_phys_p95.png)](outputs/canonical_pass/plots/rollout_phys_p95.png) |
+
+Open the full visual package here:
+
+- [VISUAL_INDEX.md](VISUAL_INDEX.md)
+- [outputs/canonical_pass/videos/compare_triptych.mp4](outputs/canonical_pass/videos/compare_triptych.mp4)
+- [outputs/canonical_pass/report.md](outputs/canonical_pass/report.md)
+
+## The Claim In Plain Terms
+
+After enforcing deterministic cross-simulator alignment between PyBullet and MuJoCo, this repo learns a residual next-state correction that:
+
+- reduces Bullet-to-MuJoCo one-step physical error,
+- remains stable under long-horizon rollout checks,
+- passes holdout and alignment gates,
+- and can be inspected visually through replay videos, triptychs, and overlay plots.
+
+## Canonical Story
+
+1. Deterministic paired plans are executed in PyBullet and MuJoCo.
+2. A strict alignment gate blocks training if reset state, timing, or first-step consistency drift.
+3. A residual model predicts the MuJoCo-minus-Bullet next-state gap.
+4. Hard-mode stress evaluation verifies one-step accuracy, holdouts, and rollout stability.
+5. Behavioral acceptance exports replay videos, triptychs, and overlay plots for inspection.
+
+## Canonical Evidence
+
+- Quantitative anchor: packaged in `outputs/canonical_pass/source_stress_report.md` and `outputs/canonical_pass/source_stress_metrics.json`
+- Visual anchor: packaged in `outputs/canonical_pass/source_behavioral_report.md` and the copied videos and preview images
+- Public-facing copied bundle: [outputs/canonical_pass/](outputs/canonical_pass/)
+- Provenance map: [configs/canonical_sources.json](configs/canonical_sources.json)
+
+## Exact Quickstart
+
+This public repo is optimized for inspection first. Open [QUICKSTART.md](QUICKSTART.md) for the shortest path through the packaged evidence and for command references preserved from the source workspace.
+
+## What Lives Where
+
+- [outputs/canonical_pass/](outputs/canonical_pass/) contains the reviewer-facing proof artifacts.
+- [examples/canonical_commands.ps1](examples/canonical_commands.ps1) contains exact rerun commands.
+- [docs/CANONICAL_SOURCES.md](docs/CANONICAL_SOURCES.md) records provenance.
+- [docs/PUBLISHING.md](docs/PUBLISHING.md) defines what to ship in a public release.
+- The interactive website is published from the `gh-pages` branch.
+- Package implementation lives under `src/sim2sim_onepass/`.
+- License is [Apache-2.0](LICENSE).

sim2sim_onepass-0.1.0/PYPI_PACKAGE_NOTES.md

@@ -0,0 +1,108 @@
+# PyPI Package Notes
+
+This branch adds a curated Python companion package for the public Sim2Sim-OnePass repo.
+
+## Package Name
+
+- distribution: `sim2sim-onepass`
+- import: `sim2sim_onepass`
+- CLI: `sim2sim-onepass`
+- package page: `https://pypi.org/project/sim2sim-onepass/`
+
+## Design Decisions
+
+- The package uses a modern `src/` layout.
+- The CLI is the main public interface.
+- Lightweight, package-worthy logic is implemented directly in `src/sim2sim_onepass/`.
+- Simulator-heavy workflows are exposed as guarded wrappers instead of pretending the full simulator workspace ships in PyPI.
+- The public docs and outputs remain repo-first; the package is an adapter layer, not a replacement repo layout.
+- The package is intentionally a lightweight companion package, not a standalone robotics simulator framework.
+
+## Command Categories
+
+### Standalone
+
+- `info`
+- `quickstart`
+- `repo-map`
+- `results-summary`
+- `visual-index`
+- `docs`
+- `check-env`
+
+These should work immediately after install.
+
+### Dataset-dependent
+
+- `quick-sanity`
+- `rollout-check`
+
+These require user-provided paired data, except that `quick-sanity --demo` uses the tiny built-in synthetic fixture.
+
+### Full repo / simulator dependent
+
+- `alignment-gate`
+- `alignment-report`
+
+These are intentionally guarded. They require the full curated repo layout plus simulator dependencies and workflow files.
+
+## Included In Packaging
+
+- package source under `src/sim2sim_onepass/`
+- CLI entrypoint
+- lightweight doc fallbacks in `src/sim2sim_onepass/resources/`
+- tiny built-in quick-sanity demo support
+- top-level markdown docs useful for source distributions
+
+## Intentionally Excluded
+
+- `data_pybullet/`
+- `data_mujoco/`
+- giant videos and report dumps under `outputs/`
+- website assets and frontend code from `gh-pages`
+- local env folders such as `.venv`, `.bridge`, `.bridge312`, `.pybullet`, `.mojoco`
+- full simulator env trees and raw internal workspace structure
+- heavyweight ML dependencies from the base install
+
+## Curated In From The Larger Workspace
+
+- quick sanity dataset inspection logic
+- state projection logic used for rollout safety checks
+- minimal rollout-check model loading and evaluation wrapper
+
+These were brought in as packaging-friendly code instead of copying the full original script tree.
+
+## Torch Extras
+
+- Base install remains lightweight and does not require torch.
+- `rollout-check` uses the optional `rollout` extra.
+- If torch is missing, the user should install:
+  `pip install sim2sim-onepass[rollout]`
+
+## Local Validation Commands
+
+```powershell
+python -m pip install -e .
+sim2sim-onepass --help
+sim2sim-onepass info
+sim2sim-onepass check-env
+python -m pip install -U build twine
+python -m build
+python -m twine check dist/*
+```
+
+## Published Install
+
+```powershell
+python -m pip install sim2sim-onepass
+python -m pip install "sim2sim-onepass[rollout]"
+```
+
+## Publish Checklist
+
+1. Confirm the target branch is `pypi-package`.
+2. Verify package metadata in `pyproject.toml`.
+3. Verify no giant outputs are accidentally included in the source distribution.
+4. Run local build validation.
+5. Confirm Apache-2.0 is the intended published license.
+6. Do not publish until command behavior and package scope are reviewed against the public repo contents.

sim2sim_onepass-0.1.0/QUICKSTART.md

@@ -0,0 +1,137 @@
+# Quickstart
+
+This page is the shortest path from clone to evidence.
+
+## Zero-Compute Path
+
+If you only want to inspect the curated release artifacts, open these in order:
+
+1. [`README.md`](README.md)
+2. [`VISUAL_INDEX.md`](VISUAL_INDEX.md)
+3. [`outputs/canonical_pass/preview/triptych_frame0.png`](outputs/canonical_pass/preview/triptych_frame0.png)
+4. [`outputs/canonical_pass/videos/compare_triptych.mp4`](outputs/canonical_pass/videos/compare_triptych.mp4)
+5. [`RESULTS_SUMMARY.md`](RESULTS_SUMMARY.md)
+
+## Package Install
+
+Editable install from the repo:
+
+```powershell
+python -m pip install -e .
+```
+
+Published PyPI install:
+
+```powershell
+python -m pip install sim2sim-onepass
+```
+
+Package page:
+
+```text
+https://pypi.org/project/sim2sim-onepass/
+```
+
+Optional rollout extra:
+
+```powershell
+python -m pip install "sim2sim-onepass[rollout]"
+```
+
+First commands to run after install:
+
+```powershell
+sim2sim-onepass info
+sim2sim-onepass check-env
+sim2sim-onepass quickstart
+sim2sim-onepass results-summary
+```
+
+## Fastest Path
+
+This public repository already includes the selected proof artifacts. You can verify the main story without running any code:
+
+1. Open [`outputs/canonical_pass/report.md`](outputs/canonical_pass/report.md)
+2. Open [`outputs/canonical_pass/metrics_summary.json`](outputs/canonical_pass/metrics_summary.json)
+3. Watch [`outputs/canonical_pass/videos/compare_triptych.mp4`](outputs/canonical_pass/videos/compare_triptych.mp4)
+4. Inspect [`outputs/canonical_pass/plots/rollout_phys_p95.png`](outputs/canonical_pass/plots/rollout_phys_p95.png)
+
+## Environment Setup
+
+The command references below come from the original source workspace used to build this artifact. They are preserved here for provenance and rerun guidance, but the full source tree is not part of this trimmed public repo.
+
+```powershell
+py -m venv .bridge312
+.\.bridge312\Scripts\Activate.ps1
+python -m pip install -U pip
+pip install -r requirements_bridge312.txt
+```
+
+## Minimal Validation
+
+The package exposes lightweight public commands:
+
+```powershell
+sim2sim-onepass quick-sanity --demo
+sim2sim-onepass quick-sanity --bullet data_pybullet\paired_bullet_seed0.npz --mujoco data_mujoco\paired_mujoco_seed0.npz
+sim2sim-onepass rollout-check --bullet data_pybullet\paired_bullet_hardgen_seeds0-5.npz --mujoco data_mujoco\paired_mujoco_hardgen_seeds0-5.npz --model reports\delta_train_hardgen_fix_20260203-135301\model.pt --norm reports\delta_train_hardgen_fix_20260203-135301\normalization.json
+```
+
+Notes:
+
+- `quick-sanity --demo` is the tiny built-in package-only demo path.
+- `rollout-check` requires user-provided paired data, model, normalization files, and the optional rollout extra.
+- simulator-heavy commands such as alignment gating are intentionally guarded and require the full curated repo layout plus simulator dependencies.
+
+Run the alignment gate first. This is the repo's hard stop before any model claim:
+
+```powershell
+.\.bridge312\Scripts\python scripts\alignment_gate.py
+```
+
+Expected outcome in the source workspace: `PASS`.
+
+Run the curated behavioral proof path with the existing demo model:
+
+```powershell
+.\.bridge312\Scripts\python scripts\behavioral_acceptance_suite.py --model reports\delta_train_move_ab\model.pt --norm reports\delta_train_move_ab\normalization.json
+```
+
+What this should produce in the source workspace:
+
+- a timestamped `reports/<timestamp>/behavioral_acceptance/` folder
+- Bullet replay video
+- MuJoCo replay video
+- triptych comparison video
+- overlay plots
+- a `report.md` with PASS/FAIL gates
+
+## Main Claim Verification
+
+This is the canonical quantitative command used for the public claim, using the existing hard-mode model and datasets:
+
+```powershell
+.\.bridge312\Scripts\python scripts\stress_suite.py --bullet data_pybullet\paired_bullet_hardgen_seeds0-5.npz --mujoco data_mujoco\paired_mujoco_hardgen_seeds0-5.npz --model reports\delta_train_hardgen_fix_20260203-135301\model.pt --norm reports\delta_train_hardgen_fix_20260203-135301\normalization.json --horizons 50,200,500 --nstart 200 --seed 0 --hard_mode 1
+```
+
+Expected canonical source result in the source workspace: `reports/stress_20260203-173231`.
+
+## Inspect Outputs
+
+Open these packaged copies after running or after browsing the preselected release bundle:
+
+- [`outputs/canonical_pass/report.md`](outputs/canonical_pass/report.md)
+- [`outputs/canonical_pass/metrics_summary.json`](outputs/canonical_pass/metrics_summary.json)
+- [`outputs/canonical_pass/plots/`](outputs/canonical_pass/plots/)
+- [`outputs/canonical_pass/preview/`](outputs/canonical_pass/preview/)
+- [`outputs/canonical_pass/videos/`](outputs/canonical_pass/videos/)
+
+## Build Prep
+
+Local package build commands:
+
+```powershell
+python -m pip install -U build twine
+python -m build
+python -m twine check dist/*
+```