50-Parameter Registration Card Template v1.0 | Chapter 0 — Preface & User Guide

Home ／ Docs-Technical WhitePaper ／ 50-Parameter Registration Card Template v1.0

Chapter 0 — Preface & User Guide

Volume: Parameter Registration Card Template v1.0
Section Title: Chapter 0 — Preface & User Guide

I. Purpose & Scope

• Define unified conventions for naming, domains & units, lineage & freshness, validation & release of cross-pipeline parameters to ensure consistency and traceability from acquisition to computation to export.
• Applicable to physical constants, calibration parameters, algorithm hyperparameters, environmental and geometric/timebase parameters; aligned with PTN Template v1.0, Experimental Protocol Card Template v1.0, and Error Budget Card Template v1.0.
• Not applicable: temporary variables without measurable units/dimensions or lacking lineage/freshness policy (kept internal, not registered).

II. Audience & Applicability

• Audience: parameter owners/maintainers, metrology & data governance, review & release leads, implementation/API developers.
• Scope: parameters related to T_arr, Phi, τ_sys, Δτ_ch, reference quantities c_ref/λ_ref, medium n_eff, etc., for registration and publication.

III. Citations & Versioning

• Fixed syntax: See "<Volume> vX.Y" <Chapter> <Anchor>; prioritize P/S/M/I anchors.
• Stability line: public releases cite v1.* only; if v0.* appears, mark “draft / non-committal” prominently.
• Keep text and data-side see[]/references[] consistent with anchor coverage ≥ 90%; external links/aliases are forbidden; versioning uses SemVer.

IV. Normative Forms (math & path)

• Arrival time (two equivalent forms):
  T_arr = ( 1 / c_ref ) * ( ∫ n_eff d ell )
  T_arr = ( ∫ ( n_eff / c_ref ) d ell )
• Phase accumulation:
  Phi = ( 2π / λ_ref ) * ( ∫ n_eff d ell )
• Requirement: for parameters involving path quantities, explicitly show gamma(ell) and d ell in text; in the card data, record delta_form ∈ {general, factored}. Include check_dim_report.json; publication requires p_dim = 1.0.

V. Card Composition & Fields

• Minimal fields: param_id (key), name, symbol, domain{type,unit,range,default,precision}, lineage (source/instrument/run), freshness{valid_from,valid_to,policy}, uncertainty{type/estimate/distribution/coverage}, constraints{depends_on/derived}, cov_group, status{draft/stable/deprecated}, see[]/references[]/version.
• Style: identifiers in snake_case; symbols use international short forms (e.g., c_ref, λ_ref, τ_sys).

VI. Compliance & Gates

• G4 Dimensional closure: all expressions/units pass I70-dim_check; p_dim = 1.0.
• G5 Freshness: |ts_now − calib.timestamp| ≤ τ_calib and clock_state = locked; overdue → Restricted or recalibration.
• G2 Citation compliance: anchor coverage ≥ 90%, no external links/aliases.
• G8 Uniqueness: unique param_id; registry checksum not duplicated.

VII. Outputs & Exports

• Required: param_registry.csv (registry), param_card.yaml (card), params_schema.json (schema), check_dim_report.json (dimensions), audit.jsonl (audit).
• Optional: gate_map.yaml (parameter-level gate mapping), openapi.yaml (query/resolve APIs).

VIII. Dependencies & Cross-Refs

• Terms & dimensions: See "EFT.WP.Core.Terms v1.0" P10-*, See "EFT.WP.Core.Metrology v1.0" check_dim.
• Control equations & path: See "EFT.WP.Core.Equations v1.1" Ch.2 S20-1/S21-2.
• Data contract & release: See "EFT.WP.Core.DataSpec v1.0" TARR, PTN Template v1.0 Ch.5/Ch.11.
• Error & covariance: See "Error Budget Card Template v1.0" Ch.5/Ch.8/Ch.9.

IX. Pre-Flight Checklist

• param_id/name/symbol/domain(unit/range/default/precision) with lineage/freshness complete.
• For path-related parameters: explicit gamma(ell)/d ell in text, and delta_form recorded in the card.
• check_dim_report.json passes; p_dim = 1.0; clock_state = locked, τ_calib compliant.
• uncertainty{type/estimate/distribution/coverage} and cov_group recorded with transparent coverage.
• see[]/references[]/version compliant with anchor coverage ≥ 90%; status ∈ {draft/stable/deprecated} set.
• param_registry.csv / param_card.yaml / params_schema.json / audit.jsonl generated and signed; unique checksum.