pamoja-sim 0.1.18__tar.gz

pamoja_sim-0.1.18/.gitignore

@@ -0,0 +1,13 @@
+# Native extensions are built per platform, not committed.
+*.so
+*.pyd
+*.dylib
+
+# Build and packaging output.
+dist/
+wheels/
+target/
+
+# Local virtual environments.
+.venv/
+venv/

pamoja_sim-0.1.18/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anthony Wiedman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pamoja_sim-0.1.18/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: pamoja-sim
+Version: 0.1.18
+Summary: Noisy and replay sensors, a recording actuator, and a simulated robot that dead-reckons its pose.
+Project-URL: Repository, https://github.com/molexxxx/pamoja
+Project-URL: Documentation, https://pamoja.molex.cloud/docs/guides/sim.html
+Author: molexxxx
+License: MIT
+License-File: LICENSE-MIT
+Keywords: iot,pamoja,robotics,sim
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pamoja-native==0.1.18
+Description-Content-Type: text/markdown
+
+# pamoja-sim
+
+Noisy and replay sensors, a recording actuator, and a simulated robot that dead-reckons its pose. One capability of [pamoja](https://github.com/molexxxx/pamoja), one memory-safe Rust core with bindings for TypeScript, Python, and C#.
+
+[![read the guide](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-guide.svg)](https://pamoja.molex.cloud/docs/guides/sim.html)
+[![documentation](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-docs.svg)](https://pamoja.molex.cloud/docs/)
+[![API reference](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-api.svg)](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html)
+
+## Install
+
+```sh
+pip install pamoja-sim
+```
+
+```python
+from pamoja import sim
+```
+
+This pulls in `pamoja-native`, the compiled engine. `pip install pamoja` is the whole framework in one package.
+
+## Example
+
+The script the test suite runs, spliced here as it ran.
+
+From [`bindings/python/guides/sim.py`](https://github.com/molexxxx/pamoja/blob/main/bindings/python/guides/sim.py):
+
+```python
+import asyncio
+
+from pamoja.sim import RecordingActuator, Replay, SimulatedRobot
+
+
+async def main() -> None:
+    # The clear distance ahead, in meters, taken from an earlier survey run. A replay hands
+    # it back one reading at a time, so the loop below sees the same input on every run: the
+    # same rover code, driven by a recording rather than a range finder.
+    capture = [4.0, 3.0, 1.5, 0.5]
+    ahead = Replay(capture)
+    throttle = RecordingActuator()
+    rover = SimulatedRobot(0.5)  # each command advances the rover half a second
+
+    seen = []
+    for _ in capture:
+        reading = await ahead.read()
+        seen.append(reading)
+
+        # Drive on while there is room ahead, otherwise stop and turn on the spot.
+        clear = reading > 1.0
+        speed = 1.0 if clear else 0.0
+        turn = 0.0 if clear else 1.0
+        await throttle.apply(speed)
+        await rover.apply(vx=speed, omega=turn)
+        print(f"{reading} m ahead, so drive at {speed} and turn at {turn}")
+
+    # The recording actuator kept every command, which is how a test says what the control
+    # loop decided rather than only what it ended up doing.
+    commands = await throttle.commands()
+    print(f"commands  {commands}")
+
+    # Three half-second commands at 1 m/s reach 1.5 m along x. The last one turns on the
+    # spot at 1 rad/s for half a second, which moves the rover nowhere.
+    pose = await rover.pose()
+    print(f"pose      x {pose.x:.1f} m, y {pose.y:.1f} m, heading {pose.theta:.1f} rad")
+
+    return seen, commands, pose
+
+
+seen, commands, pose = asyncio.run(main())
+```
+
+## The same capability in every language
+
+| Language | Package | Reference |
+| --- | --- | --- |
+| Rust | [`pamoja-sim`](https://crates.io/crates/pamoja-sim) | [reference](https://pamoja.molex.cloud/docs/reference/rust/pamoja_sim/index.html), [docs.rs](https://docs.rs/pamoja-sim), [install](https://pamoja.molex.cloud/docs/reference/rust.html#rust-sim) |
+| TypeScript | [`@pamoja/sim`](https://www.npmjs.com/package/@pamoja/sim) | [reference](https://pamoja.molex.cloud/docs/reference/node/modules/_pamoja_sim.html), [install](https://pamoja.molex.cloud/docs/reference/node.html#node-sim) |
+| Python | [`pamoja-sim`](https://pypi.org/project/pamoja-sim/) | [reference](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html), [install](https://pamoja.molex.cloud/docs/reference/python.html#python-sim) |
+| C# | [`Pamoja.Sim`](https://www.nuget.org/packages/Pamoja.Sim) | [reference](https://pamoja.molex.cloud/docs/reference/dotnet/api/Pamoja.Sim.html), [install](https://pamoja.molex.cloud/docs/reference/dotnet.html#dotnet-sim) |
+
+## Documentation
+
+- [`pamoja.sim` reference](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html), every class and function in this module.
+- [The Simulators guide](https://pamoja.molex.cloud/docs/guides/sim.html), with the same example in Rust, TypeScript, and C#.
+- [Every capability](https://pamoja.molex.cloud/docs/), and the [install page](https://pamoja.molex.cloud/docs/install.html).
+
+## License
+
+MIT

pamoja_sim-0.1.18/README.md

@@ -0,0 +1,88 @@
+# pamoja-sim
+
+Noisy and replay sensors, a recording actuator, and a simulated robot that dead-reckons its pose. One capability of [pamoja](https://github.com/molexxxx/pamoja), one memory-safe Rust core with bindings for TypeScript, Python, and C#.
+
+[![read the guide](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-guide.svg)](https://pamoja.molex.cloud/docs/guides/sim.html)
+[![documentation](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-docs.svg)](https://pamoja.molex.cloud/docs/)
+[![API reference](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-api.svg)](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html)
+
+## Install
+
+```sh
+pip install pamoja-sim
+```
+
+```python
+from pamoja import sim
+```
+
+This pulls in `pamoja-native`, the compiled engine. `pip install pamoja` is the whole framework in one package.
+
+## Example
+
+The script the test suite runs, spliced here as it ran.
+
+From [`bindings/python/guides/sim.py`](https://github.com/molexxxx/pamoja/blob/main/bindings/python/guides/sim.py):
+
+```python
+import asyncio
+
+from pamoja.sim import RecordingActuator, Replay, SimulatedRobot
+
+
+async def main() -> None:
+    # The clear distance ahead, in meters, taken from an earlier survey run. A replay hands
+    # it back one reading at a time, so the loop below sees the same input on every run: the
+    # same rover code, driven by a recording rather than a range finder.
+    capture = [4.0, 3.0, 1.5, 0.5]
+    ahead = Replay(capture)
+    throttle = RecordingActuator()
+    rover = SimulatedRobot(0.5)  # each command advances the rover half a second
+
+    seen = []
+    for _ in capture:
+        reading = await ahead.read()
+        seen.append(reading)
+
+        # Drive on while there is room ahead, otherwise stop and turn on the spot.
+        clear = reading > 1.0
+        speed = 1.0 if clear else 0.0
+        turn = 0.0 if clear else 1.0
+        await throttle.apply(speed)
+        await rover.apply(vx=speed, omega=turn)
+        print(f"{reading} m ahead, so drive at {speed} and turn at {turn}")
+
+    # The recording actuator kept every command, which is how a test says what the control
+    # loop decided rather than only what it ended up doing.
+    commands = await throttle.commands()
+    print(f"commands  {commands}")
+
+    # Three half-second commands at 1 m/s reach 1.5 m along x. The last one turns on the
+    # spot at 1 rad/s for half a second, which moves the rover nowhere.
+    pose = await rover.pose()
+    print(f"pose      x {pose.x:.1f} m, y {pose.y:.1f} m, heading {pose.theta:.1f} rad")
+
+    return seen, commands, pose
+
+
+seen, commands, pose = asyncio.run(main())
+```
+
+## The same capability in every language
+
+| Language | Package | Reference |
+| --- | --- | --- |
+| Rust | [`pamoja-sim`](https://crates.io/crates/pamoja-sim) | [reference](https://pamoja.molex.cloud/docs/reference/rust/pamoja_sim/index.html), [docs.rs](https://docs.rs/pamoja-sim), [install](https://pamoja.molex.cloud/docs/reference/rust.html#rust-sim) |
+| TypeScript | [`@pamoja/sim`](https://www.npmjs.com/package/@pamoja/sim) | [reference](https://pamoja.molex.cloud/docs/reference/node/modules/_pamoja_sim.html), [install](https://pamoja.molex.cloud/docs/reference/node.html#node-sim) |
+| Python | [`pamoja-sim`](https://pypi.org/project/pamoja-sim/) | [reference](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html), [install](https://pamoja.molex.cloud/docs/reference/python.html#python-sim) |
+| C# | [`Pamoja.Sim`](https://www.nuget.org/packages/Pamoja.Sim) | [reference](https://pamoja.molex.cloud/docs/reference/dotnet/api/Pamoja.Sim.html), [install](https://pamoja.molex.cloud/docs/reference/dotnet.html#dotnet-sim) |
+
+## Documentation
+
+- [`pamoja.sim` reference](https://pamoja.molex.cloud/docs/reference/python/pamoja/sim.html), every class and function in this module.
+- [The Simulators guide](https://pamoja.molex.cloud/docs/guides/sim.html), with the same example in Rust, TypeScript, and C#.
+- [Every capability](https://pamoja.molex.cloud/docs/), and the [install page](https://pamoja.molex.cloud/docs/install.html).
+
+## License
+
+MIT

pamoja_sim-0.1.18/pamoja/sim/__init__.py

@@ -0,0 +1,22 @@
+"""Idiomatic simulated-device facade.
+
+Drive a whole node with no hardware attached: a sensor that drifts, a replay of a
+real capture, an actuator that records what it was told, and a robot that moves
+only in arithmetic. A lossy link is `Transport.degraded`, since it wraps a
+transport rather than standing alone.
+"""
+
+from __future__ import annotations
+
+from pamoja._native import Pose, RecordingActuatorHandle, Replay, SimulatedRobot, SimulatedSensor
+
+__all__ = [
+    "Pose",
+    "RecordingActuator",
+    "Replay",
+    "SimulatedRobot",
+    "SimulatedSensor",
+]
+
+#: An actuator that records every command instead of acting on one.
+RecordingActuator = RecordingActuatorHandle

pamoja_sim-0.1.18/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pamoja-sim"
+version = "0.1.18"
+description = "Noisy and replay sensors, a recording actuator, and a simulated robot that dead-reckons its pose."
+readme = "README.md"
+license = { text = "MIT" }
+license-files = ["LICENSE-MIT"]
+requires-python = ">=3.10"
+authors = [{ name = "molexxxx" }]
+keywords = ["pamoja", "iot", "robotics", "sim"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pamoja-native==0.1.18",
+]
+
+[project.urls]
+Repository = "https://github.com/molexxxx/pamoja"
+Documentation = "https://pamoja.molex.cloud/docs/guides/sim.html"
+
+[tool.hatch.build.targets.wheel]
+packages = ["pamoja"]