From 8cf6be3d64efc60d823de20f96600c850eb1a52b Mon Sep 17 00:00:00 2001 From: Luis Raimundo Date: Sun, 24 May 2026 23:36:48 +0100 Subject: [PATCH] Fix public repository documentation status after final-density merge Co-authored-by: Cursor --- CHANGELOG.md | 4 ++-- README.md | 6 ++++-- TECHNICAL_MANUAL.md | 4 ++-- TESTING.md | 2 +- docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md | 4 ++-- docs/CURRENT_DOCUMENTATION_INDEX.md | 6 +++--- docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md | 13 +++++++++++++ docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md | 6 +++--- .../FORMULA_VALIDATION_PLAN_INDEX.md | 6 +++--- .../METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md | 11 ++++++----- ...2_PASSED_PASSES_1_15.md => VALIDATION_STATUS.md} | 7 ++++--- {instalers => installers}/windows/START-HERE.bat | 0 12 files changed, 43 insertions(+), 26 deletions(-) create mode 100644 docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md rename docs/validation/{VALIDATION_STATUS_812_PASSED_PASSES_1_15.md => VALIDATION_STATUS.md} (91%) rename {instalers => installers}/windows/START-HERE.bat (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5450fda..e9db9d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Pairwise dissonance internals:** replaced `for i / for j` nested loops in `dissonance_models.py` (`_dissonance_total_and_pairs`, `_dissonance_total_pairs_and_minamp`, `SetharesDissonance._pairwise_sum`) with upper-triangular index arrays (`np.triu_indices`) and pair-array evaluation. - **Citation metadata alignment:** updated `CITATION.cff` author metadata/ORCID, funding DOI identifier, and set `version: "3.7.0"` to match the current package version and README acknowledgements block. -- **Repository spelling hygiene:** renamed installer path `instalers/` to `installers/` and updated installer README path references accordingly (git history follows the rename for path-level redirection). +- **Repository spelling hygiene:** normalized installer path naming to `installers/` and updated installer README path references accordingly. ### Deprecated @@ -44,7 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Documentation -- **Formula extraction & formula validation (Passes 1–15):** completed pytest coverage under **`tests/formula_validation/`** (149 tests, 0 failures in the recorded cycle) aligned with **`docs/formula_extraction/`** and **`docs/formula_validation/`** plans. Status: **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`**. Methodology: **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. Optional traceability: **`CODE_FORMULA_TRACEABILITY_TABLE.md`**. Indexes: **`docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md`**, **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`**. Cross-linked **`README.md`**, **`docs/CURRENT_DOCUMENTATION_INDEX.md`**, **`docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md`** §10, **`TECHNICAL_MANUAL.md`** §10.3, **`TESTING.md`**. +- **Formula extraction & formula validation (Passes 1–15):** completed pytest coverage under **`tests/formula_validation/`** aligned with **`docs/formula_extraction/`** and **`docs/formula_validation/`** plans. Status: **`docs/validation/VALIDATION_STATUS.md`**. Methodology: **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. Optional traceability: **`CODE_FORMULA_TRACEABILITY_TABLE.md`**. Indexes: **`docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md`**, **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`**. Cross-linked **`README.md`**, **`docs/CURRENT_DOCUMENTATION_INDEX.md`**, **`docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md`** §10, **`TECHNICAL_MANUAL.md`** §10.3, **`TESTING.md`**. - **Mathematical formalisation (first pass):** added **`docs/MATHEMATICAL_FORMALISATION_VERIFICATION_REPORT_FIRST_PASS.md`** (LaTeX formulas, code-grounded verification for six `density.py` functions) and linked it from **`docs/CURRENT_DOCUMENTATION_INDEX.md`**. - **Research export (`compiled_density_metrics_research.xlsx`):** documented Excel-safe behaviour (worksheet **AutoFilter** only—no ListObject **Table** XML), optional CLI metadata, and column-header sanitisation. Cross-linked **`README.md`**, **`docs/CURRENT_DOCUMENTATION_INDEX.md`**, **`docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md`**, **`TECHNICAL_MANUAL.md`** §5.3, **`API_REFERENCE.md`**, **`TESTING.md`**, and the **`tools/export_research_density_workbook.py`** module docstring. diff --git a/README.md b/README.md index 1ee8c76..16834ee 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ pip install --upgrade --force-reinstall -r requirements-pins.txt | **[docs/MATHEMATICAL_FORMALISATION_VERIFICATION_REPORT_FIRST_PASS.md](docs/MATHEMATICAL_FORMALISATION_VERIFICATION_REPORT_FIRST_PASS.md)** | LaTeX formalisation of six core `density.py` metrics (read-only vs code). | | **[docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md](docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md)** | Pass 1–15 **formula-extraction** tables (Python → notation); companion to validation plans and tests. | | **[docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md](docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md)** | Pass 1–15 **formula-validation plans** (fixtures and assertions; plans only). | -| **[VALIDATION_STATUS_812_PASSED_PASSES_1_15.md](VALIDATION_STATUS_812_PASSED_PASSES_1_15.md)** | Recorded pytest counts: full suite **812 passed** (39 skipped, 0 failed); **149** formula-validation tests passed; Passes **1–15** completed. | +| **[docs/validation/VALIDATION_STATUS.md](docs/validation/VALIDATION_STATUS.md)** | Formula-validation status note for Passes **1–15** (without fixed full-suite pass/fail claims). | | **[METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md](METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md)** | Methodological note on extraction → validation workflow and limits of what automated checks establish. | | **[CODE_FORMULA_TRACEABILITY_TABLE.md](CODE_FORMULA_TRACEABILITY_TABLE.md)** | Optional code ↔ formula traceability (audit / PDF-oriented). | | **[docs/COMPUTATIONAL_METRICS_CODE_REVIEW_REPORT.md](docs/COMPUTATIONAL_METRICS_CODE_REVIEW_REPORT.md)** | Project-owned computational code inventory for formalisation / peer review (not a user guide). | @@ -86,7 +86,9 @@ Older Markdown snapshots (integrated vs Tk `v2_16` notes, external **`split_audi python -m pytest tests -v ``` -**Formula-validation (Passes 1–15):** executable checks under **`tests/formula_validation/`** implement the per-pass validation plans against selected numerical fixtures. As recorded in **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`**, the formula-validation suite reports **149 passed**, **0 failed**, and the full repository suite **812 passed**, **39 skipped**, **0 failed** for that recorded run. The formula-validation corpus supports **internal consistency** between the documented formulas and the tested Python implementations; it verifies formula/code agreement for those fixtures and **does not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. See **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** for scope and limitations. +**Formula-validation (Passes 1–15):** executable checks under **`tests/formula_validation/`** implement the per-pass validation plans against selected numerical fixtures. The formula-validation corpus supports **internal consistency** between the documented formulas and the tested Python implementations; it verifies formula/code agreement for those fixtures and **does not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. See **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** for scope and limitations. + +See `docs/FINAL_ACCEPTANCE_REPORT.md` and `docs/KNOWN_BASELINE_TEST_FAILURES.md` for the current test status. ```bash python -m pytest tests/formula_validation/ -q diff --git a/TECHNICAL_MANUAL.md b/TECHNICAL_MANUAL.md index 1d191b2..cc63be6 100644 --- a/TECHNICAL_MANUAL.md +++ b/TECHNICAL_MANUAL.md @@ -5,7 +5,7 @@ **Technical manual revision:** 10.1 **Date:** May 2026 **Authors:** Senior Software Engineer & Digital Signal Processing (DSP) Specialist -**Latest updates:** Manual aligned to **current** export contract (`Density_Metrics` + `docs/DENSITY_EXPORT_SCHEMA.md`); `effective_partial_density` documented as the sole **public** spectral-fatness scalar; Stage‑2 **`density_weighted_sum`** / compile **`weight_function`** semantics summarised in §3.2 (`compile_metrics`) and §5.3 with normative detail in **`docs/DENSITY_EXPORT_SCHEMA.md` §C.1**; **default per-note `Legacy_Density_Metrics`** sheet (SDM/FDM/CDM) and research-export **`density_weighted_sum_cdm_mean`** + column highlights documented in §5.3 and **`docs/DENSITY_EXPORT_SCHEMA.md` §F1 / §R**; legacy `Density Metric` / `Combined` / `R_norm` stack scoped to legacy sheets / diagnostic outputs (not slim `Metrics`); v5 spectral-masking GUI **not** exposed in v6; compiled workbook multi-sheet layout; dissonance on separate sheet; **§10.3** documents completed **formula extraction / formula-validation** Passes **1–15** (`tests/formula_validation/`, status **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`**). +**Latest updates:** Manual aligned to **current** export contract (`Density_Metrics` + `docs/DENSITY_EXPORT_SCHEMA.md`); `effective_partial_density` documented as the sole **public** spectral-fatness scalar; Stage‑2 **`density_weighted_sum`** / compile **`weight_function`** semantics summarised in §3.2 (`compile_metrics`) and §5.3 with normative detail in **`docs/DENSITY_EXPORT_SCHEMA.md` §C.1**; **default per-note `Legacy_Density_Metrics`** sheet (SDM/FDM/CDM) and research-export **`density_weighted_sum_cdm_mean`** + column highlights documented in §5.3 and **`docs/DENSITY_EXPORT_SCHEMA.md` §F1 / §R**; legacy `Density Metric` / `Combined` / `R_norm` stack scoped to legacy sheets / diagnostic outputs (not slim `Metrics`); v5 spectral-masking GUI **not** exposed in v6; compiled workbook multi-sheet layout; dissonance on separate sheet; **§10.3** documents completed **formula extraction / formula-validation** Passes **1–15** (`tests/formula_validation/`, status **`docs/validation/VALIDATION_STATUS.md`**). > **Architecture notice (scientific pipeline, May 2026):** Normative export contract: **`Density_Metrics`** columns, **`effective_partial_density`**, dissonance on **`Dissonance_Metrics`**, optional PCA sheets, batch **H+I+S** vs model weights **H/(H+I)** / **I/(H+I)**, and GUI policy — **`docs/DENSITY_EXPORT_SCHEMA.md`**, **`docs/BATCH_ANALYSIS_AUDIT.md`**, **`docs/BATCH_ANALYSIS_FIELD_MAP.md`**. Sections on **legacy** amplitude / combined metrics, **masking**, or **PC1/PC2** are labelled explicitly where they are not the publication path. Default physical pipeline: **spectral masking disabled**. @@ -2197,7 +2197,7 @@ Sensitivity plots include a `plot_metadata.json` file with a hash of the paramet Project-owned computational expressions are summarised in **formula-extraction** tables (**`docs/formula_extraction/`**, Passes **1–15**; index: **`FORMULA_EXTRACTION_INDEX.md`**). **Formula-validation plans** (**`docs/formula_validation/`**, same passes; index: **`FORMULA_VALIDATION_PLAN_INDEX.md`**) define small numerical fixtures. **pytest** modules under **`tests/formula_validation/`** implement those checks. -For a recorded validation cycle, **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** states: full repository suite **812 passed**, **39 skipped**, **0 failed**; formula-validation suite **149 passed**, **0 failed**; Passes **1–15** completed. Methodological framing and explicit limits are in **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. Optional audit-oriented linkage of code lines to notation is in **`CODE_FORMULA_TRACEABILITY_TABLE.md`**. +Formula-validation Passes **1–15** are documented in **`docs/validation/VALIDATION_STATUS.md`**. Current full-suite status (including documented baseline failures) is tracked in **`docs/FINAL_ACCEPTANCE_REPORT.md`** and **`docs/KNOWN_BASELINE_TEST_FAILURES.md`**. Methodological framing and explicit limits are in **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. Optional audit-oriented linkage of code lines to notation is in **`CODE_FORMULA_TRACEABILITY_TABLE.md`**. **Interpretation (cautious):** the formula-validation corpus supports **internal consistency** between the documented mathematical formulas and the tested Python implementations. It verifies formula/code agreement for **selected numerical fixtures**. It does **not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. diff --git a/TESTING.md b/TESTING.md index dc967bc..0b48426 100644 --- a/TESTING.md +++ b/TESTING.md @@ -21,7 +21,7 @@ The marker is registered in `pyproject.toml` under python -m pytest tests/formula_validation/ -q ``` -**Meaning (cautious):** these tests support **internal consistency** between the documented mathematical formulas and the tested Python implementations for the **selected numerical fixtures** in each validation plan. They do **not**, by themselves, prove scientific optimality, universal correctness, or full acoustic validity of the models. Counts and pass coverage for a recorded cycle are summarised in **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`**; methodology in **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. +**Meaning (cautious):** these tests support **internal consistency** between the documented mathematical formulas and the tested Python implementations for the **selected numerical fixtures** in each validation plan. They do **not**, by themselves, prove scientific optimality, universal correctness, or full acoustic validity of the models. Formula-validation status is summarised in **`docs/validation/VALIDATION_STATUS.md`**; methodology in **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. Current full-suite status is tracked in **`docs/FINAL_ACCEPTANCE_REPORT.md`** and **`docs/KNOWN_BASELINE_TEST_FAILURES.md`**. ## How to run diff --git a/docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md b/docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md index e93182d..dc153d9 100644 --- a/docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md +++ b/docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md @@ -224,8 +224,8 @@ This section is **orthogonal** to the Stage 1/2 Excel contract above: it documen | **`docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md`** | Index to Pass **1–15** formula-extraction tables (Python expressions → notation). | | **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`** | Index to Pass **1–15** validation plans (fixtures and suggested assertions). | | **`tests/formula_validation/`** | Pytest modules implementing those plans for Passes **1–15**. | -| **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** (repo root) | Recorded cycle: full suite **812 passed** (39 skipped, 0 failed); formula-validation **149 passed** (0 failed). | -| **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** (repo root) | Methodological note on the extraction → validation workflow. | +| **`docs/validation/VALIDATION_STATUS.md`** | Formula-validation status summary (Passes 1–15) without fixed full-suite pass/fail assertions. | +| **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** | Methodological note on the extraction → validation workflow. | | **`CODE_FORMULA_TRACEABILITY_TABLE.md`** (repo root) | Optional code ↔ formula traceability table. | **Cautious interpretation:** the formula-validation corpus supports **internal consistency** between the documented mathematical formulas and the tested Python implementations. It verifies formula/code agreement for **selected numerical fixtures**. It does **not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. diff --git a/docs/CURRENT_DOCUMENTATION_INDEX.md b/docs/CURRENT_DOCUMENTATION_INDEX.md index fadc9f1..49b9ee7 100644 --- a/docs/CURRENT_DOCUMENTATION_INDEX.md +++ b/docs/CURRENT_DOCUMENTATION_INDEX.md @@ -1,6 +1,6 @@ # Current documentation index -**Last audit:** 2026-05-17 (legacy density export + research compromise column / highlights; prior passes 2026-05-14, 2026-05-13). **Formula validation:** Passes **1–15** completed in pytest (`tests/formula_validation/`); see **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** and **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. +**Last audit:** 2026-05-17 (legacy density export + research compromise column / highlights; prior passes 2026-05-14, 2026-05-13). **Formula validation:** Passes **1–15** completed in pytest (`tests/formula_validation/`); see **`docs/validation/VALIDATION_STATUS.md`** and **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`**. **Pipeline contract (high level):** `proc_audio.AudioProcessor` → per-note `spectral_analysis.xlsx` → `compile_metrics.compile_density_metrics_with_pca` → `compiled_density_metrics.xlsx` **Schema / export version strings:** see per-workbook `Analysis_Metadata` (`ANALYSIS_SCHEMA_VERSION`, `pipeline_contract_version`, `export_schema_version`, etc.) — this index does not duplicate those runtime values. @@ -24,8 +24,8 @@ | [docs/COMPUTATIONAL_METRICS_CODE_REVIEW_REPORT.md](COMPUTATIONAL_METRICS_CODE_REVIEW_REPORT.md) | Read-only inventory of **project-owned** computational lines and functions (density, alignment, policy, compile hooks); prioritises mathematical formalisation. External libraries are black-boxed. | | [docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md](formula_extraction/FORMULA_EXTRACTION_INDEX.md) | **Formula extraction (Passes 1–15):** tables mapping project-owned Python → mathematical notation. | | [docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md](formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md) | **Formula-validation plans (Passes 1–15):** hand-checkable fixtures and suggested assertions (plans only; executable tests live under `tests/formula_validation/`). | -| [VALIDATION_STATUS_812_PASSED_PASSES_1_15.md](../VALIDATION_STATUS_812_PASSED_PASSES_1_15.md) | **Recorded test cycle:** full suite **812 passed** (39 skipped, 0 failed); formula-validation **149 passed** (0 failed); Passes **1–15** completed. | -| [METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md](../METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md) | Methodological note: extraction → validation workflow; what is and is not established by automated formula checks. | +| [docs/validation/VALIDATION_STATUS.md](validation/VALIDATION_STATUS.md) | Formula-validation status note for Passes **1–15**; for current full-suite status see `docs/FINAL_ACCEPTANCE_REPORT.md` and `docs/KNOWN_BASELINE_TEST_FAILURES.md`. | +| [docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md](validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md) | Methodological note: extraction → validation workflow; what is and is not established by automated formula checks. | | [CODE_FORMULA_TRACEABILITY_TABLE.md](../CODE_FORMULA_TRACEABILITY_TABLE.md) | Optional **code ↔ formula** traceability (function, script, line ranges, expressions). | **Formula-validation (methodological, cautious):** the formula-validation corpus supports **internal consistency** between the documented mathematical formulas and the tested Python implementations. It verifies formula/code agreement for **selected numerical fixtures**. It does **not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. diff --git a/docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md b/docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md new file mode 100644 index 0000000..d28e4b7 --- /dev/null +++ b/docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md @@ -0,0 +1,13 @@ +# Post-Merge Public Repository Audit + +Date: 2026-05-24 +Scope: post-merge public-documentation hygiene checks only (no metric/formula/GUI/pipeline changes). + +| Issue | status before | status now | action taken | remaining risk | +|---|---|---|---|---| +| Documentation test-status contradiction | Present (`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md` and fixed `0 failed` wording conflicted with current documented baseline-failure state) | Fixed | Renamed to `docs/validation/VALIDATION_STATUS.md`; removed fixed full-suite pass/fail claims; updated public references and README wording to point to `docs/FINAL_ACCEPTANCE_REPORT.md` and `docs/KNOWN_BASELINE_TEST_FAILURES.md`. | Low: historical manifests may still include snapshot counts as archival records. | +| instalers typo | Present (`instalers/windows/START-HERE.bat`) | Fixed | Moved file to `installers/windows/START-HERE.bat` via git move; confirmed no remaining `instalers` directory or references. | Low | +| final-density acceptance evidence | Present | Present (verified) | Confirmed existence of `docs/FINAL_ACCEPTANCE_REPORT.md`, `docs/GUI_OPTION_EFFECT_AUDIT.md`, `docs/KNOWN_BASELINE_TEST_FAILURES.md`, `docs/QUICK_GUIDE.md`, `docs/TUTORIAL.md`, `docs/TECHNICAL_MANUAL.md`; verified acceptance claims in final report. | Low | +| GUI audit consistency | Checked | Pass | Verified no `NOT EXPOSED` and no central `FAIL`; central controls are documented as PASS (`density_summation_mode`, weights, salience threshold, ceiling, metadata propagation, workbook propagation). | Low | +| release documentation consistency | Checked | Pass | Reconciled public references for validation status docs and current test-status wording. | Low | + diff --git a/docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md b/docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md index 76f26bd..2ba803d 100644 --- a/docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md +++ b/docs/formula_extraction/FORMULA_EXTRACTION_INDEX.md @@ -43,13 +43,13 @@ In `FORMULA_EXTRACTION_TABLE_DENSITY_FIRST_PASS.md`, the `np.abs(power)` row use - Exhaustive, line-by-line coverage of `proc_audio.py` (Pass 10 and 13 remain partial by design) - Final thesis-ready prose (tables are reference artefacts, not narrative) -**Executable regression checks** for Passes **1–15** live under **`tests/formula_validation/`** (see **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`**, **`TESTING.md`**, and **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`**). Those tests implement the plans; they do not replace domain review. +**Executable regression checks** for Passes **1–15** live under **`tests/formula_validation/`** (see **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`**, **`TESTING.md`**, and **`docs/validation/VALIDATION_STATUS.md`**). Those tests implement the plans; they do not replace domain review. ## 6. Related documentation - **`docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md`** — validation-plan index (fixtures / assertions). - **`tests/formula_validation/`** — pytest implementation. -- **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** (repo root) — recorded pass counts for a completed cycle. -- **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** (repo root) — workflow and cautious interpretation. +- **`docs/validation/VALIDATION_STATUS.md`** — formula-validation status note for Passes 1–15. +- **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** — workflow and cautious interpretation. - **`CODE_FORMULA_TRACEABILITY_TABLE.md`** (repo root) — optional code ↔ formula traceability. - Legacy consolidated split: [`FORMULA_VALIDATION_PLAN.md`](FORMULA_VALIDATION_PLAN.md) (older umbrella; per-pass plans are authoritative for new work). diff --git a/docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md b/docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md index 3b0ff88..fac3ab3 100644 --- a/docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md +++ b/docs/formula_validation/FORMULA_VALIDATION_PLAN_INDEX.md @@ -4,7 +4,7 @@ These documents define **small, hand-checkable numerical examples** so each case can confirm that **Python outputs match the formulas** recorded in the formula-extraction tables (**Passes 1–15**). The markdown files are **validation plans only** (they do not execute tests or modify application code). The corresponding **pytest** modules live under **`tests/formula_validation/`** and implement the plans for **Passes 1–15**. -**Cautious interpretation:** the formula-validation corpus supports **internal consistency** between the documented mathematical formulas and the tested Python implementations. It verifies formula/code agreement for **selected numerical fixtures**. It does **not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. See **`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** (repo root) and **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** for a recorded cycle summary. +**Cautious interpretation:** the formula-validation corpus supports **internal consistency** between the documented mathematical formulas and the tested Python implementations. It verifies formula/code agreement for **selected numerical fixtures**. It does **not**, by itself, prove scientific optimality, universal correctness, or full acoustic validity of the models. See **`docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`** and **`docs/validation/VALIDATION_STATUS.md`** for methodology and status. ## 2. Documents @@ -36,7 +36,7 @@ The consolidated source split from the extraction tree is still available as [`. ## 4. Related (repo root) -- [`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`](../../VALIDATION_STATUS_812_PASSED_PASSES_1_15.md) — recorded pytest counts (full suite and formula-validation subset). -- [`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`](../../METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md) — methodological note. +- [`VALIDATION_STATUS.md`](../validation/VALIDATION_STATUS.md) — formula-validation status note (Passes 1–15). +- [`METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md`](../validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md) — methodological note. - [`CODE_FORMULA_TRACEABILITY_TABLE.md`](../../CODE_FORMULA_TRACEABILITY_TABLE.md) — optional traceability table. - [`../formula_extraction/FORMULA_EXTRACTION_INDEX.md`](../formula_extraction/FORMULA_EXTRACTION_INDEX.md) — formula-extraction index. diff --git a/docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md b/docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md index 3348b00..5aef6c2 100644 --- a/docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md +++ b/docs/validation/METHODOLOGICAL_NOTE_FORMULA_VALIDATION.md @@ -47,11 +47,12 @@ The method combined **static documentation** with **targeted dynamic checks**: ## 4. Validation result -As recorded for the completed cycle: +As documented for this completed formula-validation cycle: -- **Full pytest result:** 812 passed, 39 skipped, 0 failed. -- **Formula-validation suite:** 149 passed, 0 failed. -- **Formula-validation passes completed:** 1–15. +- **Formula-validation passes completed:** 1–15. +- Current full-suite and baseline status are tracked in: + - `docs/FINAL_ACCEPTANCE_REPORT.md` + - `docs/KNOWN_BASELINE_TEST_FAILURES.md` (Full-suite runs may still emit **warnings**—for example dependency deprecations or expected edge-case warnings—as summarised in the status document cited below; those warnings did not cause failures in the recorded run.) @@ -91,4 +92,4 @@ The computational metrics were subjected to a formula-extraction and formula-val ## 9. Status note -The file **`VALIDATION_STATUS_812_PASSED_PASSES_1_15.md`** (repository root) is the **final status record** for this validation cycle: it summarises the recorded pytest counts, lists Passes 1–15, states what the validation supports and does not prove, and notes warning behaviour during the full-suite run. **It is a static human-readable status note and does not execute tests.** +The file **`docs/validation/VALIDATION_STATUS.md`** is the status record for this validation cycle: it summarises Passes 1–15 and validation scope/limits. **It is a static human-readable status note and does not execute tests.** diff --git a/docs/validation/VALIDATION_STATUS_812_PASSED_PASSES_1_15.md b/docs/validation/VALIDATION_STATUS.md similarity index 91% rename from docs/validation/VALIDATION_STATUS_812_PASSED_PASSES_1_15.md rename to docs/validation/VALIDATION_STATUS.md index 710d453..2d5e67b 100644 --- a/docs/validation/VALIDATION_STATUS_812_PASSED_PASSES_1_15.md +++ b/docs/validation/VALIDATION_STATUS.md @@ -1,9 +1,10 @@ -# Validation Status — 812 Passed — Formula Passes 1–15 +# Validation Status — Formula Passes 1–15 ## 1. Full test-suite result -- **Full pytest result:** 812 passed, 39 skipped, 0 failed. -- **Formula-validation suite:** 149 passed, 0 failed. +- Current full-suite status is documented in: + - `docs/FINAL_ACCEPTANCE_REPORT.md` + - `docs/KNOWN_BASELINE_TEST_FAILURES.md` - **Formula-validation passes completed:** Passes 1–15. ## 2. Formula-validation coverage diff --git a/instalers/windows/START-HERE.bat b/installers/windows/START-HERE.bat similarity index 100% rename from instalers/windows/START-HERE.bat rename to installers/windows/START-HERE.bat