gds-framework 0.2.0__tar.gz

gds_framework-0.2.0/.claude/settings.local.json

@@ -0,0 +1,49 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv sync:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(git ls-tree:*)",
+      "Bash(git checkout:*)",
+      "Bash(git reset:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git branch:*)",
+      "Bash(git push:*)",
+      "Bash(uv run ruff check:*)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework status)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework diff)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework log --oneline -5)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework add:*)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework commit -m \"$\\(cat <<''EOF''\nfix: resolve all 32 ruff lint errors\n\nMigrate \\(str, Enum\\) to StrEnum, use Field\\(default_factory=list\\) for\nmutable defaults, sort __all__ lists, move imports into TYPE_CHECKING\nblocks where safe, combine nested if statements, inline return\nconditions, replace pytest.raises\\(Exception\\) with ValidationError,\nand break long lines under 100 chars.\nEOF\n\\)\")",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework push)",
+      "Bash(gh -R BlockScience/gds-framework run list --limit 5)",
+      "Bash(gh -R BlockScience/gds-framework run view 21997230766 --log-failed)",
+      "Bash(uv run ruff format:*)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework commit -m \"$\\(cat <<''EOF''\nstyle: apply ruff format to all source and test files\nEOF\n\\)\")",
+      "Bash(uv run mypy:*)",
+      "Bash(gh repo view:*)",
+      "Bash(gh repo edit:*)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework commit -m \"$\\(cat <<''EOF''\nfix: resolve all mypy strict errors\n\nRename validate methods to avoid shadowing Pydantic BaseModel.validate:\nTypeDef.validate → check_value, StateVariable.validate → check_value,\nSpace.validate → validate_data, GDSSpec.validate → validate_spec.\nConsolidate frozen=True into ConfigDict where model_config already\nexists. Add type params to bare dict annotations.\nEOF\n\\)\")",
+      "Bash(uv run python:*)",
+      "Bash(ls:*)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework status -u)",
+      "Bash(git -C /home/rohan/Documents/Github/gds-framework diff --stat)",
+      "mcp__plugin_context7-plugin_context7__resolve-library-id",
+      "mcp__plugin_context7-plugin_context7__query-docs",
+      "mcp__playwright__browser_navigate",
+      "mcp__playwright__browser_snapshot",
+      "mcp__playwright__browser_click",
+      "mcp__playwright__browser_run_code",
+      "mcp__playwright__browser_take_screenshot",
+      "Bash(fdfind:*)",
+      "Bash(git -C:*)",
+      "Bash(for f in examples/*/generate_views.py)",
+      "Bash(do sed -i 's/^def main\\(\\):/def main\\(\\) -> None:/' \"$f\")",
+      "Bash(done)",
+      "Bash(for d in sir_epidemic thermostat lotka_volterra prisoners_dilemma insurance)",
+      "Bash(do uv run python examples/$d/generate_views.py --save)",
+      "Bash(git init:*)"
+    ]
+  }
+}

gds_framework-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint
+        run: uv run ruff check gds/ tests/
+
+      - name: Format check
+        run: uv run ruff format --check gds/ tests/
+
+      - name: Type check
+        run: uv run mypy gds/
+
+      - name: Test
+        run: uv run pytest tests/ -v --cov=gds --cov-report=term-missing

gds_framework-0.2.0/.gitignore

@@ -0,0 +1,30 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+
+# uv
+uv.lock
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/

gds_framework-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [pydantic>=2.10]
+        args: [--config-file=pyproject.toml]
+        pass_filenames: false
+        entry: mypy gds/

gds_framework-0.2.0/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: "Mehta"
+    given-names: "Rohan"
+    email: "rohan@block.science"
+    affiliation: "BlockScience"
+title: "gds-framework"
+version: 0.2.0
+date-released: 2026-02-21
+references:
+  - type: article
+    authors:
+      - family-names: "Shorish"
+        given-names: "Jamsheed"
+      - family-names: "Zargham"
+        given-names: "Michael"
+    title: "Generalized Dynamical Systems, Part I: Foundations"
+    url: "https://blog.block.science/generalized-dynamical-systems-part-i-foundations-2/"
+    year: 2021

gds_framework-0.2.0/CLAUDE.md

@@ -0,0 +1,93 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project
+
+`gds-framework` — typed compositional specifications for complex systems, grounded in Generalized Dynamical Systems theory. Published on PyPI as `gds-framework`, imported as `gds`.
+
+## Commands
+
+```bash
+uv sync                                    # Install dependencies
+uv run pytest tests/ -v                    # Run all 336 tests
+uv run pytest tests/test_blocks.py -v      # Single test file
+uv run pytest tests/test_blocks.py::TestStackComposition::test_rshift_operator -v  # Single test
+uv build                                   # Build wheel (gds_framework-*.whl)
+uv run python -c "import gds; print(gds.__version__)"  # Verify install
+```
+
+## Architecture
+
+### Two-Layer Design
+
+**Layer 1 — Composition Algebra** (the engine):
+Blocks with bidirectional typed interfaces, composed via four operators (`>>`, `|`, `.feedback()`, `.loop()`). A 3-stage compiler flattens composition trees into flat IR (blocks + wirings + hierarchy). Six generic verification checks (G-001..G-006) validate structural properties on the IR.
+
+**Layer 2 — Specification Layer** (the framework):
+TypeDef with runtime constraints, typed Spaces, Entities with StateVariables, Block roles (BoundaryAction/Policy/Mechanism/ControlAction), GDSSpec registry, ParameterSchema (Θ), canonical projection (CanonicalGDS), Tagged mixin, semantic verification (SC-001..SC-007), SpecQuery for dependency analysis, and JSON serialization.
+
+### Two Type Systems
+
+These coexist at different levels and serve different purposes:
+
+1. **Token-based** (`types/tokens.py`) — lightweight structural matching at composition/wiring time. Port names auto-tokenize; `tokens_subset()` and `tokens_overlap()` check set containment. Used by composition validators, auto-wiring, and G-001/G-005 checks.
+
+2. **TypeDef-based** (`types/typedef.py`) — rich runtime validation at the data level. TypeDef wraps a Python type + optional constraint predicate. Used by Spaces and Entities to validate actual data values.
+
+### Compilation Pipeline
+
+```
+Block tree  →  flatten()  →  list[AtomicBlock]  →  block_compiler()  →  list[BlockIR]
+            →  _walk_wirings()  →  list[WiringIR]  (explicit + auto-wired)
+            →  _extract_hierarchy()  →  HierarchyNodeIR tree  →  _flatten_sequential_chains()
+            =  SystemIR(blocks, wirings, hierarchy)
+```
+
+Auto-wiring for `>>` matches `forward_out` ports to `forward_in` ports by token overlap. Feedback marks `is_feedback=True`; temporal marks `is_temporal=True`.
+
+### Block Hierarchy
+
+The composition algebra is **sealed** — only 5 concrete Block types exist:
+- `AtomicBlock` — leaf node (domain packages subclass this, never the composition operators)
+- `StackComposition` (`>>`) — sequential, validates token overlap
+- `ParallelComposition` (`|`) — independent, no type validation
+- `FeedbackLoop` (`.feedback()`) — backward within timestep
+- `TemporalLoop` (`.loop()`) — forward across timesteps, enforces COVARIANT only
+
+Block roles (`BoundaryAction`, `Policy`, `Mechanism`, `ControlAction`) subclass `AtomicBlock` and add constraints: BoundaryAction enforces `forward_in=()`, Mechanism enforces `backward_in=()` and `backward_out=()`.
+
+### Verification
+
+Pluggable: `verify(system, checks=None)` runs check functions against SystemIR. Each check is `Callable[[SystemIR], list[Finding]]`. Generic checks (G-001..G-006) validate IR topology. Semantic checks (SC-001..SC-007) validate GDSSpec properties (completeness, determinism, reachability, type safety, parameter references, canonical wellformedness).
+
+### Parameter System
+
+`ParameterDef` + `ParameterSchema` define the configuration space Θ at the specification level. Parameters are structural metadata — GDS does not assign values or bind them. `GDSSpec.parameter_schema` holds the registry; blocks reference parameters via `params_used: list[str]`.
+
+### Canonical Projection
+
+`project_canonical(spec: GDSSpec) → CanonicalGDS` is a pure function that derives the formal GDS decomposition: X (state), U (input), D (decision), Θ (parameters), g (policy), f (mechanism). Operates on GDSSpec (not SystemIR) because SystemIR is flat and lacks role/entity info.
+
+### Tagged Mixin
+
+`Tagged` is a BaseModel mixin providing `tags: dict[str, str]` with `with_tag()`, `with_tags()`, `has_tag()`, `get_tag()`. Applied to Block, Entity, GDSSpec. Tags are inert — stripped at compile time (BlockIR/SystemIR have no tags field), never affect verification or composition.
+
+## Key Conventions
+
+- **All data models are Pydantic v2 `BaseModel`** — not dataclasses, not plain classes
+- **Frozen models** for value objects: Port, Interface, Wiring, Space, TypeDef, StateVariable, Wire, SpecWiring
+- **`@model_validator(mode="after")` returning `Self`** for construction-time validation (composition operators, role constraints)
+- **`ConfigDict(arbitrary_types_allowed=True)`** on models storing `type` or `Callable` fields (TypeDef, Space, StateVariable, GDSSpec)
+- **Absolute imports only** — always `from gds.blocks.base import ...`, never relative
+- **`TYPE_CHECKING` guard** in `blocks/base.py` to break circular dependency with `blocks/composition.py`
+- **`Field(default_factory=list)`** for mutable defaults, never bare `[]`
+- **`@property`** for computed attributes on models, not `computed_field()`
+- **String enums** (`str, Enum`) for JSON-friendly serialization (FlowDirection, CompositionType, Severity)
+- **Custom exceptions** inherit from `GDSError` base: `GDSTypeError` for port mismatches, `GDSCompositionError` for structural constraint violations
+- All public symbols re-exported through `gds/__init__.py` with explicit `__all__`
+- Package name on PyPI is `gds-framework`, import name is `gds` (mapped via `[tool.hatch.build.targets.wheel] packages = ["gds"]`)
+
+## Intellectual Lineage
+
+The design synthesizes: GDS theory (Roxin; Zargham & Shorish), MSML (BlockScience), BDP-lib, and categorical cybernetics (Ghani, Hedges). See `docs/gds_deepdive.md` for the full analysis and `docs/gds_improvement_plan.md` for the roadmap.

gds_framework-0.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2024 BlockScience
+
+   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.