56-Report-Level Methods Appendix Template v1.0 | Appendix A Data Dictionary & Symbol Table

Home ／ Docs-Technical WhitePaper ／ 56-Report-Level Methods Appendix Template v1.0

Appendix A Data Dictionary & Symbol Table

I. Purpose & Scope (Mandatory)

• Fix a unified caliber for data dictionary—field specs—symbol table—units & dimensions—citation anchors, enabling searchability, alignment, and reuse.
• Applies to inputs/outputs, evaluation results, and metrological quantities across all method entries in this appendix.

II. Data Dictionary Structure (Mandatory)

• Organization: hierarchical domain → collection → field; for each field record name, type, unit, dimension, value range/encoding, missing policy, source & anchor.
• Versioning: dataset@version + sha256; field-level change log field_rev with breaking flag.

III. Field Specification & Constraints (Mandatory)

IV. Symbol Table (minimal unified set, Mandatory)

V. Units & Dimensions (Mandatory)

• Base: T:s, L:m, M:kg, Q:C, Θ:K, One:1.
• Common derived: velocity m·s^-1, density m^-3, energy J, power W.
• Checks: at equation locations set check_dim=true; per-field unit/dim are required and must match the method entry.

VI. Arrival-Time Consistency (Mandatory)

1. Unified forms:
   • Factored: T_arr = ( 1 / c_ref ) * ( ∫ n_eff d ell )
   • General: T_arr = ( ∫ ( n_eff / c_ref ) d ell )
2. In the same paragraph declare path gamma(ell) and measure d ell; record in machine metadata delta_form ∈ {general, factored} and Δell/ε_int/τ_c; forbid bare n/c and unparenthesized expressions.

VII. Citations & Anchors (Mandatory)

VIII. Human × Machine Mapping (Mandatory)

IX. Machine Schema (YAML; JSON-equivalent, Mandatory)

assets:

datasets:

- { name: "cmb_set_v3", version: "v3", sha256: "sha256:…", license: "CC-BY-4.0" }

- { name: "lens_v1", version: "v1", sha256: "sha256:…", license: "CC-BY-4.0" }

dict:

collections:

- name: "measurement.arrival"

fields:

- { name: "T_arr", type: "float", unit: "s", dim: "T", required: true, missing: "forbid",

anchor: "EFT.WP.Core.Equations v1.1:S20-1" }

- name: "measurement.medium"

fields:

- { name: "n_eff", type: "float", unit: "1", dim: "1", required: true, missing: "impute" }

- { name: "c_ref", type: "float", unit: "m·s^-1", dim: "L T^-1", required: true, missing: "forbid" }

- name: "path.curve"

fields:

- { name: "gamma(ell)", type: "path", unit: "-", dim: "L", required: true }

- { name: "d ell", type: "measure", unit: "m", dim: "L", required: true }

symbols:

T_arr: { unit: "s", dim: "T", desc: "arrival time" }

n_eff: { unit: "1", dim: "1", desc: "effective refractive index" }

c_ref: { unit: "m·s^-1", dim: "L T^-1", desc: "reference propagation limit" }

T_fil: { unit: "N", dim: "M L T^-2" }

T_trans: { unit: "1", dim: "1" }

compat_rate: { unit: "1", dim: "1" }

eval:

metrics:

- { name: "gate_accuracy", direction: "↑" }

- { name: "gate_latency", direction: "↓" }

- { name: "compat_rate", direction: "↑" }

arrival_time:

delta_form: "general|factored"

path: "gamma(ell)"

measure: "d ell"

numeric: { Δell: 1e-3, ε_int: 1e-6, τ_c: 0.01 }

check_dim: true

references:

see:

- "EFT.WP.Core.Terms v1.0:P10-3"

- "EFT.WP.Core.Equations v1.1:S20-1"

- "EFT.WP.Core.Metrology v1.0:check_dim"

X. Validation Rules (regex/consistency, Mandatory)

• Dataset ID: ^[A-Za-z0-9_\-]+@v?\d+(\.\d+)*$; hash: ^sha256:[0-9a-f]{64}$.
• Fields: unique name; type ∈ {int,float,string,bool,path,measure,duration}.
• Units/dimensions: if a field participates in equations, unit and dim must be non-empty, and math.check_dim=true.
• Arrival-time: if T_arr appears, arrival_time.path/measure and delta_form are required.
• Metrics: direction ∈ {↑,↓,≈}; gate_* naming aligned with Chapter 8.
• Citations: ^EFT\.WP\.[\w\.]+ v\d+\.\d+(?:\.\d+)?:[PSMI]\d+(?:-\d+)?$ must pass.

XI. Example (human abstract × machine snippet, Mandatory)

• Human abstract: This dictionary defines measurement.arrival.T_arr (s, T), measurement.medium.{n_eff (1,1), c_ref (m·s^-1, L T^-1)}, and path gamma(ell)/d ell; evaluation metrics include gate_accuracy/latency/compat_rate; see the anchor list.
• Machine snippet:

dict.collections[0].fields[0]: { name: "T_arr", unit: "s", dim: "T", required: true }

arrival_time: { delta_form: "general", path: "gamma(ell)", measure: "d ell", check_dim: true }

eval.metrics: [{ name: "gate_accuracy", direction: "↑" }]