tensnap 0.1.0__tar.gz

tensnap-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include tensnap *.py
+recursive-include tensnap/examples *.py

tensnap-0.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: tensnap
+Version: 0.1.0
+Summary: Agent-based model visualization toolkit - Python bindings
+Author-email: billstark001 <billstark001@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/billstark001/tensnap
+Project-URL: Documentation, https://github.com/billstark001/tensnap/tree/main/docs
+Project-URL: Repository, https://github.com/billstark001/tensnap
+Project-URL: Issues, https://github.com/billstark001/tensnap/issues
+Keywords: agent-based-modeling,simulation,visualization,abm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+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 :: Visualization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: networkx>=3.0
+Requires-Dist: msgpack>=1.0.5
+Requires-Dist: websockets>=12.0
+Requires-Dist: typing-extensions>=4.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+
+# Tensnap Python Bindings
+
+Python bindings for Tensnap - an agent-based model visualization toolkit.
+
+## Installation
+
+```bash
+pip install tensnap
+```
+
+## Quick Start
+
+```python
+from tensnap import Scenario
+import asyncio
+
+# Create a scenario
+scenario = Scenario(name="my-simulation", port=8765)
+
+# Define your model logic
+# See examples/ directory for complete examples
+
+# Run the server
+asyncio.run(scenario.run())
+```
+
+## Examples
+
+Check the `examples/` directory for complete simulations:
+
+- `flock.py` - Flocking behavior
+- `sirs.py` - SIRS epidemic model
+- `sugarscape.py` - Sugarscape economic model
+
+## Documentation
+
+Full documentation: <https://github.com/billstark001/tensnap>
+
+## License
+
+See LICENSE file in the repository root.

tensnap-0.1.0/README.md

@@ -0,0 +1,41 @@
+# Tensnap Python Bindings
+
+Python bindings for Tensnap - an agent-based model visualization toolkit.
+
+## Installation
+
+```bash
+pip install tensnap
+```
+
+## Quick Start
+
+```python
+from tensnap import Scenario
+import asyncio
+
+# Create a scenario
+scenario = Scenario(name="my-simulation", port=8765)
+
+# Define your model logic
+# See examples/ directory for complete examples
+
+# Run the server
+asyncio.run(scenario.run())
+```
+
+## Examples
+
+Check the `examples/` directory for complete simulations:
+
+- `flock.py` - Flocking behavior
+- `sirs.py` - SIRS epidemic model
+- `sugarscape.py` - Sugarscape economic model
+
+## Documentation
+
+Full documentation: <https://github.com/billstark001/tensnap>
+
+## License
+
+See LICENSE file in the repository root.

tensnap-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tensnap"
+version = "0.1.0"
+description = "Agent-based model visualization toolkit - Python bindings"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+  {name = "billstark001", email = "billstark001@example.com"}
+]
+keywords = ["agent-based-modeling", "simulation", "visualization", "abm"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering :: Visualization",
+]
+dependencies = [
+  "numpy>=1.24.0",
+  "networkx>=3.0",
+  "msgpack>=1.0.5",
+  "websockets>=12.0",
+  "typing-extensions>=4.9.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/billstark001/tensnap"
+Documentation = "https://github.com/billstark001/tensnap/tree/main/docs"
+Repository = "https://github.com/billstark001/tensnap"
+Issues = "https://github.com/billstark001/tensnap/issues"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.4.0",
+  "pytest-asyncio>=0.21.0",
+  "pytest-cov>=4.1.0",
+  "mypy>=1.7.0",
+  "ruff>=0.1.0",
+  "black>=23.0.0"
+]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+select = ["E", "F", "B", "I", "N", "UP", "PL", "RUF"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+addopts = "--cov=tensnap --cov-report=html --cov-report=term-missing"

tensnap-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tensnap-0.1.0/tensnap/__init__.py

@@ -0,0 +1,13 @@
+# tensnap/__init__.py
+"""TenSnap - Agent-based model visualization toolkit"""
+
+from .server import TenSnapServer
+from .sim_loop import SimulationLoop
+from .scenario import SimulationScenario
+from .models import *
+from .bindings.basic import *
+from .bindings.mesa import *
+import tensnap.utils as utils
+
+
+__version__ = "0.1.0"

tensnap-0.1.0/tensnap/bindings/basic/__init__.py

@@ -0,0 +1,56 @@
+# tensnap/bindings/basic/__init__.py
+"""Basic bindings for TenSnap - parameter, chart, and button decorators"""
+
+from .parameter import (
+    ParameterType,
+    ParameterTypeWithoutAction,
+    ParameterBase,
+    NumberParameter,
+    BooleanParameter,
+    StringParameter,
+    EnumParameter,
+    ActionParameter,
+    Parameter,
+    BindParametersConfig,
+    bind,
+    bind_parameters,
+    get_parameter_metadata_from_namespace,
+    get_parameter_metadata_from_object,
+)
+
+from .chart import (
+    chart,
+    ChartMetadata,
+    ChartGroupMetadata,
+    ChartMetadataDict,
+    ChartGroupMetadataDict,
+    ChartProperty,
+    SimplifiedChartMetadata,
+    get_chart_metadata_from_namespace,
+    categorize_charts,
+)
+
+from .action import (
+    action,
+    get_action_metadata_from_namespace,
+)
+
+
+from .accessor import (
+
+    BindUniformAgentConfig,
+    BindGridAgentConfig,
+    BindGraphAgentNXConfig,
+    BindGraphAgentConfig,
+    bind_uniform_agent,
+    bind_grid_agent,
+    bind_graph_agent_nx,
+    bind_graph_agent,
+
+    BindUniformEnvironmentConfig,
+    BindGridEnvironmentConfig,
+    BindGraphEnvironmentConfig,
+    bind_uniform_environment,
+    bind_grid_environment,
+    bind_graph_environment,
+)

tensnap-0.1.0/tensnap/bindings/basic/accessor.py

@@ -0,0 +1,260 @@
+from abc import ABC
+
+from typing import Any, cast, Callable
+
+from tensnap.models.agent import (
+    UniformAgentAccessorDict,
+    GridAgentAccessorDict,
+    GraphAgentAccessorNXDict,
+    GraphAgentAccessorDict,
+    make_uniform_agent_accessor,
+    make_grid_agent_accessor,
+    make_graph_agent_accessor_nx,
+    make_graph_agent_accessor,
+)
+
+from tensnap.models.environment import (
+    GridEnvironmentAccessorDict,
+    GraphEnvironmentAccessorDict,
+    GraphEdgeAccessorNXDict,
+    GraphEdgeDict,
+    make_uniform_environment_accessor,
+    make_grid_environment_accessor,
+    make_graph_environment_accessor,
+    make_graph_edge_accessor_nx,
+)
+
+# region Agent Accessor Bindings
+
+
+class BindUniformAgentConfig:
+
+    def __init__(
+        self,
+        id: str = "id",
+        color: str | bool | None = None,
+        icon: str | bool | None = None,
+        size: str | bool | None = None,
+        data: str | bool | None = None,
+    ) -> None:
+        self.accessor_dict: UniformAgentAccessorDict = {
+            "id": id,
+            "color": color,
+            "icon": icon,
+            "size": size,
+            "data": data,
+        }
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_uniform = self
+        return cls
+
+    def get_accessor(self) -> Any:
+        return make_uniform_agent_accessor(**self.accessor_dict)
+
+
+bind_uniform_agent = BindUniformAgentConfig
+
+
+class BindGridAgentConfig:
+
+    def __init__(
+        self,
+        id: str = "id",
+        x: str = "x",
+        y: str = "y",
+        heading: str | bool | None = None,
+        color: str | bool | None = None,
+        icon: str | bool | None = None,
+        size: str | bool | None = None,
+        data: str | bool | None = None,
+        trajectory_length: str | bool | None = None,
+        trajectory_color: str | bool | None = None,
+    ) -> None:
+        self.accessor_dict: GridAgentAccessorDict = {
+            "id": id,
+            "x": x,
+            "y": y,
+            "heading": heading,
+            "color": color,
+            "icon": icon,
+            "size": size,
+            "data": data,
+            "trajectory_length": trajectory_length,
+            "trajectory_color": trajectory_color,
+        }
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_grid = self
+        return cls
+
+    def get_accessor(self) -> Any:
+        return make_grid_agent_accessor(**self.accessor_dict)
+
+
+bind_grid_agent = BindGridAgentConfig
+
+
+class BindGraphAgentNXConfig:
+
+    def __init__(
+        self,
+        x: str | bool | None = None,
+        y: str | bool | None = None,
+        color: str | bool | None = None,
+        icon: str | bool | None = None,
+        size: str | bool | None = None,
+        data: str | bool | None = None,
+    ) -> None:
+        self.accessor_dict: GraphAgentAccessorNXDict = {
+            "x": x,
+            "y": y,
+            "color": color,
+            "icon": icon,
+            "size": size,
+            "data": data,
+        }
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_graph_nx = self
+        return cls
+
+    def get_accessor(self) -> Any:
+        return make_graph_agent_accessor_nx(**self.accessor_dict)
+
+
+bind_graph_agent_nx = BindGraphAgentNXConfig
+
+
+class BindGraphAgentConfig:
+
+    def __init__(
+        self,
+        id: str = "id",
+        x: str | bool | None = None,
+        y: str | bool | None = None,
+        color: str | bool | None = None,
+        icon: str | bool | None = None,
+        size: str | bool | None = None,
+        data: str | bool | None = None,
+    ) -> None:
+        self.accessor_dict: GraphAgentAccessorDict = {
+            "id": id,
+            "x": x,
+            "y": y,
+            "color": color,
+            "icon": icon,
+            "size": size,
+            "data": data,
+        }
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_graph = self
+        return cls
+
+    def get_accessor(self) -> Any:
+        return make_graph_agent_accessor(**self.accessor_dict)
+
+
+bind_graph_agent = BindGraphAgentConfig
+
+# endregion
+
+# region Environment Accessor Bindings
+
+
+class BindUniformEnvironmentConfig:
+
+    def __init__(
+        self,
+    ) -> None:
+        pass
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_uniform = self
+        return cls
+
+    def get_accessor(self, id: str) -> Any:
+        return make_uniform_environment_accessor(id=id)
+
+
+bind_uniform_environment = BindUniformEnvironmentConfig
+
+
+class BindGridEnvironmentConfig:
+
+    def __init__(
+        self,
+        width: str = "width",
+        height: str = "height",
+        coord_offset: str | bool | None = None,
+        background: str | bool | None = None,
+        trajectory_length: str | bool | None = None,
+        trajectory_color: str | bool | None = None,
+    ) -> None:
+        self.accessor_dict: GridEnvironmentAccessorDict = {
+            "id": "id",
+            "width": width,
+            "height": height,
+            "coord_offset": coord_offset,
+            "background": background,
+            "trajectory_length": trajectory_length,
+            "trajectory_color": trajectory_color,
+        }
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_grid = self
+        return cls
+
+    def get_accessor(self, id: str) -> Any:
+        self.accessor_dict["id"] = id
+        return make_grid_environment_accessor(**self.accessor_dict)
+
+
+bind_grid_environment = BindGridEnvironmentConfig
+
+
+class BindGraphEnvironmentConfig:
+
+    def __init__(
+        self,
+        edges: str = "edges",
+        directed: bool = False,
+        style: str | bool | None = None,
+        width: str | bool | None = None,
+        color: str | bool | None = None,
+        edge_accessor: Callable[[Any], "GraphEdgeDict"] | bool = True,
+    ) -> None:
+        self.accessor_dict: GraphEnvironmentAccessorDict = {
+            "id": "id",
+            "edges": edges,
+        }
+        self.edge_accessor_dict: GraphEdgeAccessorNXDict = {
+            "directed": directed,
+            "style": style,
+            "width": width,
+            "color": color,
+        }
+        self.edge_accessor = edge_accessor
+
+    def __call__(self, cls):
+        cls._tensnap_bind_accessor_config_graph = self
+        return cls
+
+    def get_accessor(self, id: str) -> Any:
+        self.accessor_dict["id"] = id
+        return make_graph_environment_accessor(**self.accessor_dict)
+
+    def get_edge_accessor(self) -> Any:
+        if self.edge_accessor is True:
+            # Create a default edge accessor
+            return make_graph_edge_accessor_nx(**self.edge_accessor_dict)
+        elif self.edge_accessor is False:
+            # No edge accessor, return identity function
+            return lambda x: x
+        else:
+            # Use the provided edge accessor
+            return self.edge_accessor
+
+
+bind_graph_environment = BindGraphEnvironmentConfig

tensnap-0.1.0/tensnap/bindings/basic/action.py

@@ -0,0 +1,59 @@
+# tensnap/bindings/basic/buttons.py
+"""Button decorators and bindings"""
+
+from typing import Any, Callable, TypeVar, Dict, List, Tuple
+
+from asyncio import iscoroutinefunction
+from inspect import ismethod
+from functools import wraps
+
+from .parameter import ActionParameter
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+def action(
+    id: str | None = None, label: str | None = None, allow_runtime_change: bool = True
+) -> Callable[[F], F]:
+    """Decorator to define a button"""
+    orig_id = id
+
+    def decorator(func_orig: F) -> F:
+        if ismethod(func_orig):
+            if iscoroutinefunction(func_orig):
+
+                @wraps(func_orig)
+                async def func(*args, **kwargs) -> Any:  # type: ignore
+                    return await func_orig(*args, **kwargs)
+
+            else:
+
+                @wraps(func_orig)
+                def func(*args, **kwargs) -> Any:  # type: ignore
+                    return func_orig(*args, **kwargs)
+
+        else:
+            func = func_orig  # type: ignore
+        id = orig_id or func.__name__
+        param = ActionParameter(
+            id=id, label=label or "", allow_runtime_change=allow_runtime_change
+        )
+
+        # Store parameter and action info on the function
+        func._tensnap_action = param  # type: ignore
+        return func  # type: ignore
+
+    return decorator
+
+
+def get_action_metadata_from_namespace(namespace: Dict[str, Any]):
+    """Find all action-decorated functions in a given namespace"""
+    actions: List[Tuple[str, Callable, ActionParameter]] = []
+    for name, attr in namespace.items():
+        if name.startswith('__') and name.endswith('__'):
+            continue
+        if callable(attr) and hasattr(attr, "_tensnap_action"):
+            param = getattr(attr, "_tensnap_action")
+            if isinstance(param, ActionParameter):
+                actions.append((name, attr, param))
+    return actions