ineedvalidation 0.0.1__tar.gz

ineedvalidation-0.0.1/.gitignore

@@ -0,0 +1,222 @@
+# 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/
+docs/jupyter_execute/
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# hatch-vcs generated version file
+*_version.py

ineedvalidation-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: local
+    hooks:
+      - id: no-internal-refs
+        name: no internal research references
+        entry: python3 tools/check_internal_refs.py
+        language: system
+        types: [text]
+        exclude: ^(CHANGELOG\.md|tools/check_internal_refs\.py)$
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: name-tests-test
+        args: [--pytest-test-first]
+      - id: end-of-file-fixer
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.2
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.3.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []

ineedvalidation-0.0.1/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        # Install with the [docs] flag for sphinx docs specific extensions
+        - docs
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py

ineedvalidation-0.0.1/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.0.1 (2026-09-11)
+
+
+### Features
+
+* **cli:** lint, render and scaffold a hierarchy from the command line ([d33f9ab](https://github.com/CoreySpohn/ineedvalidation/commit/d33f9ab193b01335afd689de18788408ea3d646d))
+* **d2:** emit the tiered hierarchy diagram from nodes and evidence ([f454a4a](https://github.com/CoreySpohn/ineedvalidation/commit/f454a4a4644dc57b891af8cba101ff30ea119b2a))
+* **d2:** post-process the svg and drive the rendering binaries ([85d5506](https://github.com/CoreySpohn/ineedvalidation/commit/85d5506b4306011014f6088bfd75bc9b599abf63))
+* **evidence:** merge per-repository evidence files into node summaries ([bd8f8c5](https://github.com/CoreySpohn/ineedvalidation/commit/bd8f8c566e0f4b90c3d557e912a5ff63022d3ac8))
+* **nodes:** lint tests against the hierarchy in both directions ([26c79be](https://github.com/CoreySpohn/ineedvalidation/commit/26c79bee393720488a2dbea1d2f6c78f00a6efb6))
+* **nodes:** lint the hierarchy structure and validation levels ([63a69b9](https://github.com/CoreySpohn/ineedvalidation/commit/63a69b994d6a05c0a8a3acfa91e09819b3f7e01a))
+* **nodes:** load hierarchy notes into a node schema ([042da90](https://github.com/CoreySpohn/ineedvalidation/commit/042da90014370781cd9c65a7b8e65b3ee5d7ca6f))
+* **plugin:** collect marked tests into a per-repository evidence file ([b47aef9](https://github.com/CoreySpohn/ineedvalidation/commit/b47aef9466df3ce7dc4fbd33304bd84eed685d37))
+* **views:** named hierarchy views and the override lookup ([c0309cc](https://github.com/CoreySpohn/ineedvalidation/commit/c0309ccee5fc254b54fa107d64d4daa7629d6a52))
+
+
+### Bug Fixes
+
+* **nodes:** keep the note order in a subtree so branches render the same way twice ([2ad676f](https://github.com/CoreySpohn/ineedvalidation/commit/2ad676fad19967ced31a29ef166e11f4731727ed))
+* **tests:** skip the cli render tests when the d2 binaries are absent ([afef81d](https://github.com/CoreySpohn/ineedvalidation/commit/afef81d80aef1fc687e4836d1a468ea2adb6e39c))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([9494740](https://github.com/CoreySpohn/ineedvalidation/commit/9494740a24d0755290b7c0662b330fb5ca8484eb))

ineedvalidation-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Corey Spohn
+
+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.

ineedvalidation-0.0.1/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: ineedvalidation
+Version: 0.0.1
+Summary: Declare which physical case, evidence tier and response quantity a test exercises; collect the declarations into an evidence ledger; lint and render a validation hierarchy from it.
+Project-URL: Homepage, https://github.com/CoreySpohn/ineedvalidation
+Project-URL: Issues, https://github.com/CoreySpohn/ineedvalidation/issues
+Author-email: Corey Spohn <corey.a.spohn@nasa.gov>
+License: MIT License
+        
+        Copyright (c) 2026 Corey Spohn
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: pytest>=8
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: ipython; extra == 'docs'
+Requires-Dist: myst-nb; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autoapi; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-book-theme; extra == 'docs'
+Provides-Extra: render
+Requires-Dist: pyyaml>=6; extra == 'render'
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pyyaml>=6; extra == 'test'
+Description-Content-Type: text/markdown
+
+# ineedvalidation
+
+Declare which physical case, evidence tier and response quantity a test exercises; collect the declarations across repositories into an evidence ledger; lint and render a validation hierarchy from node notes plus that ledger.
+
+The vocabulary follows Oberkampf and Roy, *Verification and Validation in Scientific Computing* (2010): a validation hierarchy of unit, benchmark, subsystem and system cases, and a strict separation between verification (the code solves the equations correctly) and validation (the equations describe the measured world).
+
+## Marking a test
+
+```python
+import ineedvalidation as inv
+
+@inv.case("free-space-propagation", "A", srq="on-axis intensity")
+def test_matches_closed_form():
+    ...
+
+@inv.case("free-space-propagation", "B", ref="other-code")
+def test_matches_independent_code():
+    ...
+
+@inv.seam("optics", "detector")
+def test_photon_scale_anchor():
+    ...
+
+@inv.regression
+def test_frozen_output():
+    ...
+```
+
+Tiers: `A` code verification, `B` cross-code benchmark, `C` solution verification, `D` validation against measured data. Regression tests are excluded from every tier.
+
+The markers register through a pytest plugin entry point, so installing the package is the only setup a repository needs.
+
+## Collecting the evidence
+
+```console
+$ pytest --inv-evidence evidence/mylib.json
+```
+
+One JSON file per repository lists every marked test, its case, its tier and the outcome it reached. A table in `pyproject.toml` can assign a case and tier by test path, so the tagging cost is per directory rather than per test.
+
+## Linting and rendering a hierarchy
+
+```console
+$ ineedvalidation lint hierarchy/
+$ ineedvalidation render hierarchy/
+```
+
+The hierarchy is a directory of Markdown notes with YAML frontmatter, one per case. The lint checks the notes for internal consistency and checks them against the collected tests in both directions: a case no node owns, a node with no tests, a response quantity a node does not list, or a validation level claimed without a passing test that supports it. The renderer draws the tiered figure through `d2`, with named views and optional hand-edited overrides for figures that have to look right in a talk.
+
+## Status
+
+Pre-alpha. The markers, the evidence collector, the hierarchy lint and the renderer work; the API is not yet stable.

ineedvalidation-0.0.1/README.md

@@ -0,0 +1,52 @@
+# ineedvalidation
+
+Declare which physical case, evidence tier and response quantity a test exercises; collect the declarations across repositories into an evidence ledger; lint and render a validation hierarchy from node notes plus that ledger.
+
+The vocabulary follows Oberkampf and Roy, *Verification and Validation in Scientific Computing* (2010): a validation hierarchy of unit, benchmark, subsystem and system cases, and a strict separation between verification (the code solves the equations correctly) and validation (the equations describe the measured world).
+
+## Marking a test
+
+```python
+import ineedvalidation as inv
+
+@inv.case("free-space-propagation", "A", srq="on-axis intensity")
+def test_matches_closed_form():
+    ...
+
+@inv.case("free-space-propagation", "B", ref="other-code")
+def test_matches_independent_code():
+    ...
+
+@inv.seam("optics", "detector")
+def test_photon_scale_anchor():
+    ...
+
+@inv.regression
+def test_frozen_output():
+    ...
+```
+
+Tiers: `A` code verification, `B` cross-code benchmark, `C` solution verification, `D` validation against measured data. Regression tests are excluded from every tier.
+
+The markers register through a pytest plugin entry point, so installing the package is the only setup a repository needs.
+
+## Collecting the evidence
+
+```console
+$ pytest --inv-evidence evidence/mylib.json
+```
+
+One JSON file per repository lists every marked test, its case, its tier and the outcome it reached. A table in `pyproject.toml` can assign a case and tier by test path, so the tagging cost is per directory rather than per test.
+
+## Linting and rendering a hierarchy
+
+```console
+$ ineedvalidation lint hierarchy/
+$ ineedvalidation render hierarchy/
+```
+
+The hierarchy is a directory of Markdown notes with YAML frontmatter, one per case. The lint checks the notes for internal consistency and checks them against the collected tests in both directions: a case no node owns, a node with no tests, a response quantity a node does not list, or a validation level claimed without a passing test that supports it. The renderer draws the tiered figure through `d2`, with named views and optional hand-edited overrides for figures that have to look right in a talk.
+
+## Status
+
+Pre-alpha. The markers, the evidence collector, the hierarchy lint and the renderer work; the API is not yet stable.

ineedvalidation-0.0.1/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ['hatchling', "hatch-fancy-pypi-readme", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ineedvalidation"
+description = "Declare which physical case, evidence tier and response quantity a test exercises; collect the declarations into an evidence ledger; lint and render a validation hierarchy from it."
+authors = [{ name = "Corey Spohn", email = "corey.a.spohn@nasa.gov" }]
+dynamic = ['readme', 'version']
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Framework :: Pytest",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = ["pytest>=8"]
+
+[project.optional-dependencies]
+render = ["pyyaml>=6"]
+docs = ["sphinx", "myst-nb", "sphinx-book-theme", "sphinx-autoapi", "sphinx_autodoc_typehints", "ipython"]
+test = ["pytest-cov", "pyyaml>=6"]
+dev = ["pre-commit"]
+
+[project.urls]
+Homepage = "https://github.com/CoreySpohn/ineedvalidation"
+Issues = "https://github.com/CoreySpohn/ineedvalidation/issues"
+
+[project.entry-points.pytest11]
+ineedvalidation = "ineedvalidation.plugin"
+
+[project.scripts]
+ineedvalidation = "ineedvalidation.cli:main"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/ineedvalidation/_version.py"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+[tool.ruff.lint]
+select = ["B", "D", "E", "F", "I", "UP", "RUF"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ineedvalidation"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/scripts", "/docs", "/tests", "/.github"]

ineedvalidation-0.0.1/src/ineedvalidation/__init__.py

@@ -0,0 +1,12 @@
+"""Evidence declarations for tests and a validation hierarchy built from them.
+
+The test half is a pytest plugin: :func:`case`, :func:`seam` and
+:func:`regression` mark what a test demonstrates, and the plugin collects those
+marks into an evidence ledger. The render half reads hierarchy node notes plus
+that ledger, lints them against each other, and renders the hierarchy.
+"""
+
+from ineedvalidation._version import __version__
+from ineedvalidation.marks import TIERS, case, regression, seam
+
+__all__ = ["TIERS", "__version__", "case", "regression", "seam"]

ineedvalidation-0.0.1/src/ineedvalidation/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None