thundergraph-model 1.0.0__tar.gz

thundergraph_model-1.0.0/.github/ISSUE_TEMPLATE/01-bug_report.yml

@@ -0,0 +1,110 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+name: Bug report
+description: Report incorrect behavior, crashes, or regressions
+title: "[bug] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug. A **minimal repro** (code snippet or small test) helps a lot.
+
+  - type: checkboxes
+    id: dup_check
+    attributes:
+      label: Before you submit
+      options:
+        - label: I searched existing issues for duplicates
+          required: true
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: What went wrong in one or two sentences?
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Commit SHA, tag, or PyPI release (if applicable).
+      placeholder: e.g. v0.2.0 or abc1234
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Steps to reproduce
+      description: Numbered steps. Include a minimal code snippet if you can.
+      placeholder: |
+        1.
+        2.
+        3.
+      render: markdown
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: Traceback, wrong value, unexpected exception, etc.
+      render: markdown
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What you expected instead.
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: OS and Python version help narrow things down.
+      value: |
+        - OS:
+        - Python (`python -V`):
+      render: markdown
+    validations:
+      required: false
+
+  - type: textarea
+    id: pytest
+    attributes:
+      label: Test output (optional)
+      description: From the repo root, if relevant — `uv run pytest -q --no-cov`
+      render: shell
+    validations:
+      required: false
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      description: Rough bucket for triage (pick the closest match).
+      options:
+        - Execution / evaluator / run context
+        - Graph compiler / dependency graph
+        - Model authoring / define / refs
+        - Requirements / constraints
+        - External compute / integrations
+        - Analysis (sweep, impact, …)
+        - Documentation
+        - Examples / notebooks
+        - Unsure / other
+      default: 8
+    validations:
+      required: true
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Additional context
+      description: Screenshots, notebook paths, links to discussions.
+    validations:
+      required: false

thundergraph_model-1.0.0/.github/ISSUE_TEMPLATE/02-feature_request.yml

@@ -0,0 +1,62 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+name: Feature request
+description: Propose a new capability, API improvement, or enhancement
+title: "[feat] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Describe the **problem** and your **proposed solution** so maintainers can triage quickly.
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Problem / motivation
+      description: What is hard, missing, or awkward today? Link related issues with `#123`.
+      render: markdown
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: APIs, ergonomics, docs — be as specific as you can.
+      render: markdown
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Optional — other ways to solve the same problem.
+      render: markdown
+    validations:
+      required: false
+
+  - type: dropdown
+    id: scope
+    attributes:
+      label: Primary scope
+      description: Where this mainly applies.
+      options:
+        - Runtime / execution / evaluation
+        - Authoring API (`define`, context, …)
+        - Requirements / constraints
+        - External compute
+        - Analysis tooling
+        - Documentation / examples
+        - Other / not sure
+      default: 6
+    validations:
+      required: true
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Additional context
+      description: Prior art, diagrams, notebook references.
+      render: markdown
+    validations:
+      required: false

thundergraph_model-1.0.0/.github/ISSUE_TEMPLATE/03-documentation.yml

@@ -0,0 +1,58 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+name: Documentation
+description: Report unclear, missing, or incorrect documentation
+title: "[docs] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Point us to the **exact page or module** so we can fix it quickly.
+
+  - type: input
+    id: location
+    attributes:
+      label: Link or path
+      description: URL to built docs, or path under `docs/user_docs/`, or `tg_module` for API docstrings.
+      placeholder: e.g. docs/user_docs/user/quickstart.md or tg_model.execution.configured_model
+    validations:
+      required: true
+
+  - type: dropdown
+    id: doc_type
+    attributes:
+      label: Kind of issue
+      options:
+        - Wrong or outdated content
+        - Missing section / gap
+        - Typo / formatting
+        - Broken internal link (Sphinx)
+        - Example / code snippet wrong
+        - Other
+      default: 0
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What is wrong?
+      description: What did you read, and why was it confusing or incorrect?
+      render: markdown
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested fix (optional)
+      description: How you would like it to read, or offer to open a PR.
+      render: markdown
+    validations:
+      required: false
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Additional context
+    validations:
+      required: false

thundergraph_model-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
+blank_issues_enabled: true

thundergraph_model-1.0.0/.github/pull_request_template.md

@@ -0,0 +1,58 @@
+## What I did
+
+<!-- Describe the work: problem solved, approach, main files or areas touched. Use bullets if it helps. -->
+
+
+
+## Why
+
+<!-- Motivation, context, or link to issue / discussion. e.g. Fixes #123 -->
+
+
+
+## How to verify
+
+<!-- How a reviewer can validate this change (commands, UI steps, scenarios). Omit or write “see checklist” if obvious. -->
+
+
+
+## Scope
+
+<!-- e.g. tg_model/execution, docs/user_docs, examples, tests -->
+
+
+
+---
+
+## Checklist
+
+### Tests and lint
+
+From the **repository root**:
+
+- [ ] `uv run pytest` passes.
+- [ ] `uv run ruff check tg_model tests` passes (or only pre-existing issues outside your diff).
+- [ ] `uv run mypy tg_model` passes if your change touched typed surfaces.
+
+### Public API and docs
+
+- [ ] Docstrings updated for any new or changed public function, method, or module export (NumPy-style; see `docs/user_docs/docstring_style.md`).
+- [ ] If user-facing behavior changed, user docs or examples are updated in the same change or a follow-up is tracked.
+
+### Sphinx (if you edited `docs/` or API-adjacent narratives)
+
+- [ ] `uv run sphinx-build -b html docs/user_docs docs/user_docs/_build/html` succeeds (use `-W` for warnings-as-errors if you are touching the docs build in CI).
+
+
+---
+
+## Screenshots / sample output
+
+<!-- Paste snippets, API responses, or screenshots if the change is visible. Write N/A if not applicable. -->
+
+
+
+## Risk and rollback
+
+<!-- Blast radius, feature flags, migration notes, or how to revert. Write N/A if low risk. -->
+

thundergraph_model-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi-publish:
+    name: Build and publish Python distribution
+    runs-on: ubuntu-latest
+    
+    # Required for trusted publishing
+    permissions:
+      id-token: write
+      contents: read
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+          
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+          
+      - name: Build distribution
+        run: uv build
+        
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No password/token required! This uses OpenID Connect via the permissions block above.

thundergraph_model-1.0.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

thundergraph_model-1.0.0/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to **thundergraph-model** are documented here. The format is loosely
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.2.0] - 2026-03-28
+
+### Removed
+
+- **Breaking:** **`RequirementBlock`**, **`RequirementBlockRef`**, and **`ModelDefinitionContext.requirement_block(...)`** were removed from the public API. Use **`Requirement`**, **`RequirementRef`**, and **`requirement_package`**. Internal compiled node **`kind`** remains the string **`"requirement_block"`** (serialization / inspection only).
+
+### Documentation
+
+- FAQ **Upgrading from thundergraph-model before 0.2.0**; **concepts**, **API index**, **extension playbook**, **glossary**, and **drafts** updated so they no longer document removed shims. Requirement composition implementation plan **Phase 10** recorded.
+
+## [0.1.0] - 2026-03-27
+
+### Changed
+
+- **Examples:** `commercial_aircraft` Level-1 module renamed to **`program/l1_requirement_packages.py`** (was `l1_requirement_blocks.py`); **`hpc_datacenter`** gains **`README.md`** with run / evaluate / pytest commands.
+- **Tooling / quality:** `ruff check tg_model tests` and `ruff format tg_model tests` are clean; `pyright` passes on the repo (including tests and `docs/generation_docs/model_prototype_sketch.py`). Behavior dispatch tests use `cm.root` where the API expects a `PartInstance`.
+- **Requirement package constraints:** compile rejects ``expr=None``; graph compile supports symbol-free expressions (with an anchor edge from a package slot so validation/evaluation order stay well-formed).
+- **`slot_ids_for_part_subtree`** now includes value slots under composable requirement packages; uses `getattr(..., "_child_lookup", None)` so callers that pass a **`ConfiguredModel`** (only `value_slots` / `children` are forwarded) do not break behavior scoping.
+
+### Added
+
+- **`Requirement`** composable type and **`RequirementRef`** dot-access ref for nested requirement packages.
+- **`ModelDefinitionContext.requirement_package(name, type)`** — registers a nested composable requirements package; internal compiled node kind remains **`requirement_block`** for artifact compatibility.
+- **Composable `Requirement.define()`** may declare package-level **`parameter`**, **`attribute`**, and **`constraint`**. They materialize as **`ValueSlot`** handles under the configured root (e.g. ``cm.mission.x_m``), use **`symbol_owner` + path prefix** for `AttributeRef` threading (same idea as **`requirement_input`**), and participate in **`compile_graph`** / **`evaluate`** (constraints and derived attributes use **`_resolve_symbol_to_slot(..., model.root, ...)`**). **`RequirementPackageInstance`** exposes dot access from **`PartInstance`**; **`computed_by`** and **`RollupDecl`** on package slots are rejected at graph compile until supported.
+- **Compile-time expression checks** for those package **`attribute`** / **`constraint`** values: tracked unitflow symbols must be prior package parameters/attributes (declaration order), **`symbol_owner`** threaded symbols (e.g. requirement inputs), or rejected as foreign; **negative tests** cover **`port`**, **`allocate`** edges, **`parameter_ref`** from another type, and undeclared package slots.
+- **`examples/hpc_datacenter/`** — minimal notional colocation facility model (two Level-1 power requirements) plus **`notebooks/hpc_datacenter_parameter_sweep.ipynb`** demonstrating a factorial **parameter sweep** with **`compile_graph` + `validate_graph` once**, then **`ConfiguredModel.evaluate(..., validate=False)`** for each design point.
+- **Evaluation façade:** `ConfiguredModel.evaluate(inputs=…)` — lazy compilation (shared cache with `compile_graph`), optional `validate_graph` per call (default on), handle-keyed inputs (`ValueSlot` or slot `stable_id` strings). Non-breaking; existing `compile_graph` → `Evaluator` → `RunContext` flow unchanged.
+- **`System.instantiate()`** — class-method alias for `instantiate(SomeSystem)` on `System` subclasses.
+
+### Deprecated (removed in 0.2.0)
+
+- **`ModelDefinitionContext.requirement_block(...)`** and import aliases **`RequirementBlock`** / **`RequirementBlockRef`** — see **[0.2.0] Removed**.
+
+### Documentation
+
+- User guide (quickstart, mental model, FAQ, execution draft, external-compute concept) describes the **recommended** `evaluate` path vs the **explicit** pipeline.
+- Sphinx API reference: `sphinx-build -W` (warnings as errors) passes; API index links façade entry points (`ConfiguredModel.evaluate`, `instantiate`, `System.instantiate`) and a **Composable requirements** cross-reference map (`Requirement`, `requirement_package`, `RequirementRef`, `RequirementPackageInstance`).
+- Developer guide (`docs/user_docs/developer/`): architecture, extension playbook, testing, and repository map describe the **recommended** façade for app code and the **explicit** pipeline for extensions, async, and debugging; cross-links from the mental model and docs implementation plan.
+- Commercial aircraft example (`examples/commercial_aircraft/`): README and integration smoke tests use **`ConfiguredModel.evaluate`** with **`ValueSlot`** keys; **`extract_cargo_jet_evaluation_report(cm, result)`** needs only **`RunResult`**; optional **`ctx=`** for demo provenance / slot summaries; explicit pipeline cross-linked from README.
+- Terminology aligned for composable requirements: **`Requirement`** / **`requirement_package`** / **`RequirementRef`** in user-facing docs.
+- **Phases 6–9** (user guide, developer guide, API index / Sphinx gate, notebooks): see requirement composition implementation plan §13.