PyOctaveBand/site/src/styles/ at docs/audit-reference-theory · jmrp.io/PyOctaveBand · Tangled

jmrp.io / PyOctaveBand

0

[READ-ONLY] Mirror of https://github.com/jmrplens/PyOctaveBand. [Python3] Octave-Band and Fractional Octave-Band filter. For signal in time domain. jmrplens.github.io/PyOctaveBand/

acoustics audio filter frequency frequency-analysis frequency-domain octave python3 signal time-domain

0

PyOctaveBand / site / src / styles /

at docs/audit-reference-theory 3 files

José M. Requena Plens Docs usability: measurement-role snippet clarity, one-line result plots, responsive figures (#86) 19d ago

Docs usability: measurement-role snippet clarity, one-line result plots, responsive figures (#86) * fix: responsive figure sizing — full-width on mobile, 92% plots on desktop (plan 16 T4) Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: snippet clarity wave — recording/excitation convention (plan 16 T1) Apply the recording/excitation naming convention from the P16 audit across the calibration, intensity, block-processing, time-weighting, levels, weighting and room-acoustics guides (docs/ + EN guides + ES guides). - calibration: ref_signal->calibrator_recording, signal->recording (J1 cascade) - intensity: probe-recording synth + swap-in disclosure on p1/p2 - block-processing / time-weighting: audio_blocks provenance comments - levels / time-weighting / weighting: signal->recording, provenance upgraded to convention - room-acoustics: play/record framing on sweep/recorded; synthetic-IR stand-in note EN docs/guides kept code-identical; ES mirrored with UNE wording. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * feat: one-line canonical plots on result objects (plan 16 T2) Add a thin plot(ax=None, **kwargs) method to each result dataclass that renders the essence of its guide's canonical figure in one line, following the sklearn/statsmodels/librosa pattern. matplotlib stays a soft dependency: importing phonometry and computing works without it; .plot() raises a clear ImportError with install guidance. Rendering lives in a new lazy _plotting module; dataclass methods are thin delegates. Covers ZwickerLoudness, STIResult, WeightedRatingResult/ImpactRatingResult, RoomAcousticsResult, SoundPowerResult/ReverberationSoundPowerResult/ SoundPowerIntensityResult, IntensityResult and a new frozen DecayCurve (returned by decay_curve, tuple-unpackable for backward compat). Rating results gain band_centers/measured/shifted_reference fields for the figure. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: plot kwargs forwarding, deterministic invalid-band test, octave-impact annotation - _plot_rating now accepts **kwargs and forwards to the measured curve, so result.plot(linewidth=2) no longer raises TypeError; parametrized test covers every public .plot() forwarding a benign kwarg to its primary artist. - Replace skip-if-all-valid room-acoustics invalid-band test with a directly constructed RoomAcousticsResult (500 Hz band flagged invalid); assert exactly the flagged bars are hatched and greyed. - plot_impact_rating keeps the shifted-reference curve normatively honest (ref - shift) and marks/annotates the 500 Hz read value with the ISO 717-2 Clause 4.3.2 -5 dB octave rule instead of distorting the curve. - Move _bar_width next to its only consumer, plot_intensity. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: .plot() one-liners and figure-code collapsibles (plan 16 T3) Add one-line res.plot() mentions to every guide section whose result type gained .plot() in T2, and figure-code collapsibles (both the one-liner and the manual matplotlib path) under the five .plot()-backed data figures. Document .plot() availability and the DecayCurve return type in the API reference and CHANGELOG. EN docs + EN/ES site; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: collapsibles for STI-vs-T60 and open-plan figures Controller follow-up to plan 16 T3: the two figures are reproducible with public API only. STI-vs-T60 sweeps sti_from_impulse_response over synthetic exponential IRs at a 10-point T60 grid; the open-plan collapsible rebuilds the D2,S regression and rD/rP crossings from the OpenPlanResult fields. EN docs + EN/ES site; executed on Agg; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: final-review polish — result-field docs, comment hygiene, naming Document band_centers/measured/shifted_reference on WeightedRatingResult and ImpactRatingResult (CHANGELOG + EN/ES API tables), strip internal plan tags from theme-images.css and test_result_plots.py, note that [plot] also powers result .plot() methods, tighten the plot_zwicker_loudness docstring to say the two-panel layout only occurs when ax is None, sentence-case the intensity provenance comments, and rename the shadowed impact rating var to res_imp on the room-acoustics pages. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: PR 86 review round 1 — log-axis bars, style kwargs overrides, snippet physics and notation Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf

2 weeks ago

splash-menu.css

docs: content enrichment (4 new figures, diagrams, equations) + full SEO/GEO layer (#66) * docs: add group-delay, IEC toneburst, block-continuity and class-mask figures Four new auto-generated figures (light+dark) wired into the filter-banks, time-weighting, why-pyoctaveband and block-processing pages (docs/ EN + site EN/ES), including a new 'Verifying the IEC 61260-1 class' section documenting verify_filter_class with the acceptance-mask overlay. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: remove unreferenced legacy filter_fraction_* images Leftovers from the pre-restructure README naming; nothing references them (docs, site, scripts). Light/dark figure parity is now exact 26/26. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs(site): GEO layer - robots.txt AI opt-in, llms.txt generation, mermaid - robots.txt: universal allow + Content-Signal + explicit opt-in for 14 AI crawlers + sitemap pointer. - scripts/gen_llms.py generates llms.txt (structured project context with AI-assistant install notes) and llms-full.txt (all docs pages inline); committed at root, republished to the site via prebuild copy and regenerated in the docs workflow for freshness. New 'make llms' target. - astro-mermaid (+ mermaid) with autoTheme for the new calibration and multirate diagrams; starlight-links-validator and lastUpdated enabled. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs(site): SEO/GEO layer complete - JSON-LD, per-page heads, quality gates - Site-wide JSON-LD @graph (Person with canonical jmrp.io identity incl. ORCID, WebSite, SoftwareApplication with single-sourced version and feature list, SoftwareSourceCode) + og/twitter/author/theme metas, rel=me links, PGP key, manifest, Bing verification (Google property already verified). - Head.astro: per-page TechArticle (+speakable) and locale-aware BreadcrumbList linked into the @graph, canonical URLs, twitter tags. Footer.astro maintainer block. favicon.svg + PWA manifest. - Quality gates: sitemap lastmod stamping (git dates, postbuild), EN/ES i18n parity check, html-validate and pa11y (WCAG2AA) wired into the docs workflow with fetch-depth: 0. - Accessibility sweep: descriptive EN/ES alt text on all 147 figure references; site uses style width (valid HTML), GitHub docs keep the width attribute. - Splash landing now shows the mobile menu button (route middleware enables the sidebar; CSS hides the pane on desktop to keep the hero). - og-image: designed 1200x630 card (gpt-image-2 via inference.sh, adapted and committed); matplotlib generator kept as documented fallback. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: fix extraneous f-prefix and duplicate canonical link Starlight already emits the canonical URL; Head.astro no longer adds a second one. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs(site): WCAG2AA - convert deprecated table align attributes to CSS pa11y flagged 158 deprecated align attributes from markdown table alignment; the rehypeTableAlign plugin (ported from the reference site) rewrites them to text-align styles. 10/10 audited URLs now pass WCAG2AA. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: address review feedback (robustness, Table 4 consistency, llms links) - version regex accepts single/double quotes; rehypeTableAlign appends to existing styles; routeData guards undefined starlightRoute; Footer lang detection handles /es without trailing slash; pa11y script kills by PID (job control unavailable in some CI shells). - why-pyoctaveband: the toneburst table is Table 4 in IEC 61672-1:2013 (Table 3 is the weightings) - fixed the stale issue-#38 wording, and softened 'peaking exactly' to 'within 0.1 dB' (EN/ES). - gen_llms.py absolutizes docs-relative links so llms-full.txt resolves as a flat artifact. - Intentionally NOT changed: docs/ keeps the width attribute on images (GitHub strips style attributes); the site uses style widths. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf

3 weeks ago

theme-images.css

Docs usability: measurement-role snippet clarity, one-line result plots, responsive figures (#86) * fix: responsive figure sizing — full-width on mobile, 92% plots on desktop (plan 16 T4) Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: snippet clarity wave — recording/excitation convention (plan 16 T1) Apply the recording/excitation naming convention from the P16 audit across the calibration, intensity, block-processing, time-weighting, levels, weighting and room-acoustics guides (docs/ + EN guides + ES guides). - calibration: ref_signal->calibrator_recording, signal->recording (J1 cascade) - intensity: probe-recording synth + swap-in disclosure on p1/p2 - block-processing / time-weighting: audio_blocks provenance comments - levels / time-weighting / weighting: signal->recording, provenance upgraded to convention - room-acoustics: play/record framing on sweep/recorded; synthetic-IR stand-in note EN docs/guides kept code-identical; ES mirrored with UNE wording. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * feat: one-line canonical plots on result objects (plan 16 T2) Add a thin plot(ax=None, **kwargs) method to each result dataclass that renders the essence of its guide's canonical figure in one line, following the sklearn/statsmodels/librosa pattern. matplotlib stays a soft dependency: importing phonometry and computing works without it; .plot() raises a clear ImportError with install guidance. Rendering lives in a new lazy _plotting module; dataclass methods are thin delegates. Covers ZwickerLoudness, STIResult, WeightedRatingResult/ImpactRatingResult, RoomAcousticsResult, SoundPowerResult/ReverberationSoundPowerResult/ SoundPowerIntensityResult, IntensityResult and a new frozen DecayCurve (returned by decay_curve, tuple-unpackable for backward compat). Rating results gain band_centers/measured/shifted_reference fields for the figure. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: plot kwargs forwarding, deterministic invalid-band test, octave-impact annotation - _plot_rating now accepts **kwargs and forwards to the measured curve, so result.plot(linewidth=2) no longer raises TypeError; parametrized test covers every public .plot() forwarding a benign kwarg to its primary artist. - Replace skip-if-all-valid room-acoustics invalid-band test with a directly constructed RoomAcousticsResult (500 Hz band flagged invalid); assert exactly the flagged bars are hatched and greyed. - plot_impact_rating keeps the shifted-reference curve normatively honest (ref - shift) and marks/annotates the 500 Hz read value with the ISO 717-2 Clause 4.3.2 -5 dB octave rule instead of distorting the curve. - Move _bar_width next to its only consumer, plot_intensity. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: .plot() one-liners and figure-code collapsibles (plan 16 T3) Add one-line res.plot() mentions to every guide section whose result type gained .plot() in T2, and figure-code collapsibles (both the one-liner and the manual matplotlib path) under the five .plot()-backed data figures. Document .plot() availability and the DecayCurve return type in the API reference and CHANGELOG. EN docs + EN/ES site; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: collapsibles for STI-vs-T60 and open-plan figures Controller follow-up to plan 16 T3: the two figures are reproducible with public API only. STI-vs-T60 sweeps sti_from_impulse_response over synthetic exponential IRs at a 10-point T60 grid; the open-plan collapsible rebuilds the D2,S regression and rD/rP crossings from the OpenPlanResult fields. EN docs + EN/ES site; executed on Agg; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: final-review polish — result-field docs, comment hygiene, naming Document band_centers/measured/shifted_reference on WeightedRatingResult and ImpactRatingResult (CHANGELOG + EN/ES API tables), strip internal plan tags from theme-images.css and test_result_plots.py, note that [plot] also powers result .plot() methods, tighten the plot_zwicker_loudness docstring to say the two-panel layout only occurs when ax is None, sentence-case the intensity provenance comments, and rename the shadowed impact rating var to res_imp on the room-acoustics pages. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: PR 86 review round 1 — log-axis bars, style kwargs overrides, snippet physics and notation Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf

2 weeks ago