Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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). |
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions TECHNICAL_MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/CANONICAL_PIPELINE_AND_EXPORT_SEMANTICS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/CURRENT_DOCUMENTATION_INDEX.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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.
Expand Down
13 changes: 13 additions & 0 deletions docs/POST_MERGE_PUBLIC_REPOSITORY_AUDIT.md
Original file line number Diff line number Diff line change
@@ -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 |

Loading
Loading