simulo 0.27.0__tar.gz → 0.28.1__tar.gz

simulo-0.28.1/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: simulo
+Version: 0.28.1
+Summary: Python SDK and CLI for cloud-native robotics simulation, reinforcement learning, and robot policy training on managed GPUs.
+Author-email: Simulo Team <team@simulo.ai>
+License: BSD-3-Clause
+Project-URL: Homepage, https://simulo.ai
+Project-URL: Documentation, https://docs.simulo.ai
+Project-URL: Quickstart, https://docs.simulo.ai/getting-started/quickstart/
+Project-URL: Examples, https://github.com/simulo-org/simulo-samples
+Keywords: simulo,robotics,robotics simulation,robot training,robot learning,reinforcement learning,cloud robotics,cloud simulation,GPU simulation,policy training,physical AI,embodied AI,NVIDIA Isaac Sim,Isaac Lab,OpenUSD,USD,URDF,ONNX,MCAP,Python SDK
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: simulo-interfaces<0.21,>=0.20.1
+Requires-Dist: mcap<2,>=1.3
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: usd-core<27,>=26.5
+Provides-Extra: assets
+Requires-Dist: usd-core<27,>=26.5; extra == "assets"
+Provides-Extra: dev
+Requires-Dist: black==26.5.1; extra == "dev"
+Requires-Dist: isort==8.0.1; extra == "dev"
+Requires-Dist: ruff==0.15.21; extra == "dev"
+Requires-Dist: mypy==2.3.0; extra == "dev"
+Requires-Dist: types-defusedxml==0.7.0.20260504; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: pytest-timeout==2.4.0; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.1; extra == "dev"
+Requires-Dist: setuptools>=68; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Provides-Extra: release
+Requires-Dist: commitizen>=3.27; extra == "release"
+Requires-Dist: build>=1.2; extra == "release"
+Requires-Dist: twine>=5.1; extra == "release"
+
+# Simulo for Cloud Robotics Simulation and Training
+
+**Train robot policies in simulation on managed cloud GPUs.**
+
+Simulo is a cloud-native AI platform for robotics simulation and training. Its
+lightweight `simulo` Python SDK and CLI let you define robot-learning applications
+locally, submit them to the Simulo cloud, and inspect the results. The platform
+handles managed GPU execution, reproducible packaging, versioned assets,
+checkpoints, trained models, recordings, and live 3D viewing.
+
+The package installed on your computer is torch-free and requires no local GPU or
+simulator. The managed runtime currently uses NVIDIA Isaac Sim and Isaac Lab to
+execute reinforcement-learning training, policy evaluation and inference, and
+scripted robotics simulations.
+
+## What you can do
+
+- Write robotics applications in ordinary Python against a small, stable API.
+- Build vectorized reinforcement-learning environments and train robot policies with PPO.
+- Start with validated catalog robots or publish your own OpenUSD (USD) and URDF assets.
+- Continue training from the best or latest checkpoint produced by an earlier job.
+- Evaluate policies, run inference, and export trained policies as verified ONNX bundles.
+- Stream logs, retrieve results and outputs, capture MCAP rollout recordings, and watch a live 3D view.
+
+## Install
+
+```bash
+python -m pip install simulo
+```
+
+Simulo requires Python 3.11 or newer. One installation provides both the
+`import simulo` Python API and the `simulo` command-line interface.
+
+## Train a first policy
+
+```bash
+simulo create mybot
+simulo login
+cd mybot
+simulo run app.py --frozen --strict-assets
+```
+
+`simulo create` writes a complete starter application to your machine without
+requiring a login or network connection. The default application trains a PPO
+policy on a validated cartpole asset. `simulo run` packages the source, resolves
+and pins its assets, submits the job, and follows its cloud logs.
+
+## Explore robotics samples
+
+The public [Simulo samples repository](https://github.com/simulo-org/simulo-samples)
+contains projects for cartpole, humanoid locomotion, JetBot navigation, Franka
+arm control, a bring-your-own URDF arm, and F1TENTH-compatible drift training.
+Its current published compatibility contract is `simulo>=0.26.0,<0.27`. Check
+the repository README for the supported SDK range before running a checkout.
+
+## Monitor jobs and retrieve artifacts
+
+```bash
+simulo jobs                       # list submitted jobs and status
+simulo logs --follow              # stream the latest job's logs
+simulo result                     # read the job's result
+simulo models                     # list or download trained models
+simulo export                     # export the best policy as verified ONNX
+simulo recordings                 # download MCAP rollout recordings
+simulo outputs                    # retrieve other saved outputs
+simulo view                       # view a running --viewstream job in 3D
+simulo cancel                     # stop a queued or running job
+```
+
+Commands that accept a job ID default to the latest job and tell you which job
+they selected.
+
+## Use versioned robot assets
+
+```bash
+simulo asset list --global
+simulo asset inspect simulo/robot/cartpole:v1
+simulo asset publish ./my-robot --kind robot
+```
+
+Simulo catalogs keep robot, world, and prop assets versioned and traceable. You
+can use validated global assets immediately or publish your own USD or URDF
+package for reuse across training, evaluation, and inference jobs.
+
+## Learn more
+
+- [Quickstart](https://docs.simulo.ai/getting-started/quickstart/)
+- [Documentation](https://docs.simulo.ai/)
+- [Python API reference](https://docs.simulo.ai/api/)
+- [CLI reference](https://docs.simulo.ai/cli/)
+- [Examples](https://docs.simulo.ai/examples/)
+- [Simulo website](https://simulo.ai)

simulo-0.28.1/PYPI.md

@@ -0,0 +1,92 @@
+# Simulo for Cloud Robotics Simulation and Training
+
+**Train robot policies in simulation on managed cloud GPUs.**
+
+Simulo is a cloud-native AI platform for robotics simulation and training. Its
+lightweight `simulo` Python SDK and CLI let you define robot-learning applications
+locally, submit them to the Simulo cloud, and inspect the results. The platform
+handles managed GPU execution, reproducible packaging, versioned assets,
+checkpoints, trained models, recordings, and live 3D viewing.
+
+The package installed on your computer is torch-free and requires no local GPU or
+simulator. The managed runtime currently uses NVIDIA Isaac Sim and Isaac Lab to
+execute reinforcement-learning training, policy evaluation and inference, and
+scripted robotics simulations.
+
+## What you can do
+
+- Write robotics applications in ordinary Python against a small, stable API.
+- Build vectorized reinforcement-learning environments and train robot policies with PPO.
+- Start with validated catalog robots or publish your own OpenUSD (USD) and URDF assets.
+- Continue training from the best or latest checkpoint produced by an earlier job.
+- Evaluate policies, run inference, and export trained policies as verified ONNX bundles.
+- Stream logs, retrieve results and outputs, capture MCAP rollout recordings, and watch a live 3D view.
+
+## Install
+
+```bash
+python -m pip install simulo
+```
+
+Simulo requires Python 3.11 or newer. One installation provides both the
+`import simulo` Python API and the `simulo` command-line interface.
+
+## Train a first policy
+
+```bash
+simulo create mybot
+simulo login
+cd mybot
+simulo run app.py --frozen --strict-assets
+```
+
+`simulo create` writes a complete starter application to your machine without
+requiring a login or network connection. The default application trains a PPO
+policy on a validated cartpole asset. `simulo run` packages the source, resolves
+and pins its assets, submits the job, and follows its cloud logs.
+
+## Explore robotics samples
+
+The public [Simulo samples repository](https://github.com/simulo-org/simulo-samples)
+contains projects for cartpole, humanoid locomotion, JetBot navigation, Franka
+arm control, a bring-your-own URDF arm, and F1TENTH-compatible drift training.
+Its current published compatibility contract is `simulo>=0.26.0,<0.27`. Check
+the repository README for the supported SDK range before running a checkout.
+
+## Monitor jobs and retrieve artifacts
+
+```bash
+simulo jobs                       # list submitted jobs and status
+simulo logs --follow              # stream the latest job's logs
+simulo result                     # read the job's result
+simulo models                     # list or download trained models
+simulo export                     # export the best policy as verified ONNX
+simulo recordings                 # download MCAP rollout recordings
+simulo outputs                    # retrieve other saved outputs
+simulo view                       # view a running --viewstream job in 3D
+simulo cancel                     # stop a queued or running job
+```
+
+Commands that accept a job ID default to the latest job and tell you which job
+they selected.
+
+## Use versioned robot assets
+
+```bash
+simulo asset list --global
+simulo asset inspect simulo/robot/cartpole:v1
+simulo asset publish ./my-robot --kind robot
+```
+
+Simulo catalogs keep robot, world, and prop assets versioned and traceable. You
+can use validated global assets immediately or publish your own USD or URDF
+package for reuse across training, evaluation, and inference jobs.
+
+## Learn more
+
+- [Quickstart](https://docs.simulo.ai/getting-started/quickstart/)
+- [Documentation](https://docs.simulo.ai/)
+- [Python API reference](https://docs.simulo.ai/api/)
+- [CLI reference](https://docs.simulo.ai/cli/)
+- [Examples](https://docs.simulo.ai/examples/)
+- [Simulo website](https://simulo.ai)

{simulo-0.27.0 → simulo-0.28.1}/pyproject.toml

@@ -4,20 +4,53 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simulo"
-version = "0.27.0"
-description = "Simulo SDK and CLI — define robotics simulation and training apps in Python and run them on the Simulo cloud."
+version = "0.28.1"
+description = "Python SDK and CLI for cloud-native robotics simulation, reinforcement learning, and robot policy training on managed GPUs."
 readme = "PYPI.md"
 requires-python = ">=3.11"
 license = { text = "BSD-3-Clause" }
 authors = [{ name = "Simulo Team", email = "team@simulo.ai" }]
-keywords = ["robotics", "simulation", "reinforcement-learning", "simulo"]
+keywords = [
+    "simulo",
+    "robotics",
+    "robotics simulation",
+    "robot training",
+    "robot learning",
+    "reinforcement learning",
+    "cloud robotics",
+    "cloud simulation",
+    "GPU simulation",
+    "policy training",
+    "physical AI",
+    "embodied AI",
+    "NVIDIA Isaac Sim",
+    "Isaac Lab",
+    "OpenUSD",
+    "USD",
+    "URDF",
+    "ONNX",
+    "MCAP",
+    "Python SDK",
+]
 classifiers = [
     "Development Status :: 3 - Alpha",
+    "Environment :: Console",
     "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Distributed Computing",
     "Typing :: Typed",
 ]
 # Torch-free by construction: depends only on the contract layer and mcap.
@@ -26,7 +59,7 @@ classifiers = [
 # mcap: used by `simulo recordings` to read back a downloaded recording and
 # verify it (message count) — MIT-licensed, deps only lz4+zstandard.
 dependencies = [
-    "simulo-interfaces>=0.19.0,<0.20",
+    "simulo-interfaces>=0.20.1,<0.21",
     "mcap>=1.3,<2",
     # Hardened XML parsing for URDF ingestion (USD Asset Catalogs, PR-12 fix
     # loop 2, security NIT): stdlib xml.etree.ElementTree relies on
@@ -102,6 +135,9 @@ simulo = "simulo._client.cli:main"
 
 [project.urls]
 Homepage = "https://simulo.ai"
+Documentation = "https://docs.simulo.ai"
+Quickstart = "https://docs.simulo.ai/getting-started/quickstart/"
+Examples = "https://github.com/simulo-org/simulo-samples"
 
 # Namespace packaging: this is the only distribution that ships
 # `src/simulo/__init__.py`, so sibling `simulo.*` distributions can share the

{simulo-0.27.0 → simulo-0.28.1}/src/simulo/_client/_runner.py

@@ -27,14 +27,26 @@ from typing import Any, NoReturn, Optional
 
 from simulo.interfaces.ids import JobId, JobPublicId
 from simulo.interfaces.platform.enums import JobStatus
-from simulo.interfaces.platform.runs import JOB_SCOPE_MINE, TERMINAL_JOB_STATUSES
+from simulo.interfaces.platform.runs import JOB_SCOPE_MINE
 
 #: Poll cadence for cloud ``.get()``. Module-level so tests can shrink it.
 _POLL_INTERVAL_S = 1.0
 
-_TERMINAL_STATUS_STRINGS = frozenset(str(status) for status in TERMINAL_JOB_STATUSES)
 _COMPLETED_STATUS = str(JobStatus.COMPLETED)
 
+#: The tolerant-client check (`M55-org-runtime-policy`, issue #1537):
+#: EVERY status this client can observe outside these two live values is
+#: terminal, whether or not it is one this client's own ``JobStatus`` happens
+#: to know by name. Membership is checked as "not one of the known LIVE
+#: values", never "is one of the known TERMINAL values" — a closed terminal
+#: set silently treats a FUTURE value it has never heard of as still-live
+#: and polls forever (:class:`JobTimeoutError` only fires when the caller
+#: passed a ``timeout``; with none, :meth:`JobHandle._get_cloud` hangs).
+#: Mirrors the existing precedent for an unrecognized ``kind``
+#: (``simulo.interfaces.platform.submit``): a value outside the known set is
+#: treated as data to render, never as grounds to keep waiting on it.
+_LIVE_STATUS_STRINGS = frozenset({str(JobStatus.QUEUED), str(JobStatus.RUNNING)})
+
 
 class JobFailedError(RuntimeError):
     """A cloud job reached a terminal ``failed``/``cancelled`` status.
@@ -154,7 +166,7 @@ class JobHandle:
         while True:
             record = client.get_job(str(self._job_id), scope=JOB_SCOPE_MINE)
             status = str(record.get("status"))
-            if status in _TERMINAL_STATUS_STRINGS:
+            if status not in _LIVE_STATUS_STRINGS:
                 if status == _COMPLETED_STATUS:
                     return client.get_result(str(self._job_id), scope=JOB_SCOPE_MINE)
                 exit_code = record.get("exit_code")

{simulo-0.27.0 → simulo-0.28.1}/src/simulo/_client/app.py

@@ -514,6 +514,26 @@ def _spawn_cloud(
     # already lives there, keyed by this same `job_name`.
     job_entry = manifest.get("jobs", {}).get(job_name) or {}
     system = (job_entry.get("resources") or {}).get("system")
+    # The job's own manifest-declared `timeout` (`M55-org-runtime-policy`,
+    # issue #1537) — already validated at `@app.job(timeout=...)` decoration
+    # time and recorded on THIS job's own manifest entry, exactly like
+    # `system` just above. Forwarded explicitly to `create_job` because the
+    # control plane never parses the uploaded manifest archive itself (see
+    # `JobSubmitRequest.manifest_timeout_s`'s own docstring).
+    manifest_timeout_s = job_entry.get("timeout")
+    if manifest_timeout_s is not None and (
+        isinstance(manifest_timeout_s, bool) or not isinstance(manifest_timeout_s, int)
+    ):
+        # This manifest was just written by THIS process (see the comment on
+        # `Manifest.from_json` re-parsing above) — a non-integer `timeout`
+        # here would mean `@app.job`'s own decoration-time validation
+        # somehow let one through, not an untrusted value to degrade
+        # silently on. Fail loudly rather than send a malformed wire field.
+        raise RuntimeError(
+            f"Package at {package_path} has a non-integer jobs[{job_name!r}].timeout "
+            f"({manifest_timeout_s!r}) in its manifest — this should be impossible; "
+            "please report this as a bug."
+        )
 
     tar_path = ensure_tar(package_path)
     archive_bytes = tar_path.read_bytes()
@@ -568,6 +588,7 @@ def _spawn_cloud(
         assets=asset_pins,
         app_name=app_name,
         system=system,
+        timeout_s=manifest_timeout_s,
     )
 
     raw_public_id = record.get("public_id")
@@ -590,9 +611,24 @@ def _spawn_cloud(
         # the ref resolved to the intended source job. Seed provenance still
         # carries machine UUIDs only, so keep this confirmation neutral rather
         # than leaking a UUID while that response contract catches up.
+        #
+        # `seed["name"]`/`seed["kind"]` are server-supplied text: a
+        # compromised control plane — or a user pointed at an attacker-run
+        # `SIMULO_API_URL` — could embed ANSI/OSC sequences here, so both
+        # route through the same module `cli.py`'s own sanitizers are built
+        # on (`preflight_render`) rather than a second one.
+        # `sanitize_server_text` alone is NOT enough here (cross-vendor
+        # review): it deliberately preserves TAB/LF for its usual
+        # multi-line preflight-finding callers, but this confirmation is a
+        # single line — an unstripped LF would forge an extra line this
+        # code never printed. `_single_line` collapses it instead.
+        from simulo._client.preflight_render import sanitize_server_text_single_line
+
         seed = record.get("seed") or {}
+        seed_name = sanitize_server_text_single_line(str(seed.get("name")))
+        seed_kind = sanitize_server_text_single_line(str(seed.get("kind")))
         print(
-            f"Continuing from selected job ({seed.get('name')}, {seed.get('kind')} checkpoint)",
+            f"Continuing from selected job ({seed_name}, {seed_kind} checkpoint)",
             file=sys.stderr,
         )
 

{simulo-0.27.0 → simulo-0.28.1}/src/simulo/_client/asset_api.py

@@ -296,6 +296,7 @@ class AssetApiClient:
                 api_base_url=self._base_url,
                 timeout=_ARCHIVE_DOWNLOAD_TIMEOUT_S,
                 unavailable_hint=_UNAVAILABLE_HINT,
+                validate_download_url=True,
             )
         except http.HttpError as exc:
             raise _translate(exc) from exc

{simulo-0.27.0 → simulo-0.28.1}/src/simulo/_client/bundle.py

@@ -20,7 +20,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional, Sequence
 
 from simulo._client.asset import Asset
-from simulo._client.packaging import canonical_args, package, read_bundle_package_id
+from simulo._client.packaging import assert_credentials_outside_project, canonical_args, package, read_bundle_package_id
 from simulo._client.volume import Volume
 from simulo.interfaces.platform import is_platform_pinned
 from simulo.interfaces.platform.manifest import Manifest
@@ -222,6 +222,7 @@ def ensure_bundle(
     (deterministically restoring the correct content for this exact
     submission), never served as a silently wrong package.
     """
+    assert_credentials_outside_project(project_root)
     extra_asset_uris = tuple(sorted({asset.uri for asset in extra_assets}))
     cache_key = (id(app), job_name, canonical_args(args), extra_asset_uris)
     cached = _BUNDLE_CACHE.get(cache_key)