Home / Docs-Technical WhitePaper / 47-PTN Template v1.0
Chapter 12 — Appendices (Field Lists / Examples / Templates)
I. Field–Unit Mapping (minimal set, drop-in)
Conventions: snake_case field names; any path-dependent quantity must explicitly declare gamma(ell) and measure d ell; every numeric field must carry a unit or a see[] anchor to a dimensional check.
Group | Field | Meaning | Type | Unit/Domain | Note |
|---|---|---|---|---|---|
Core | record_id | primary key | string | ULID/UUIDv4 | globally unique |
Acquisition | acq.ts_start / acq.ts_end | start/end time | string | ISO-8601 | with timezone |
Path | path.gamma_ell | path parameterization | array[number] | m | same length as d_ell |
Path | path.d_ell | path measure step | array[number] | m | ≥2 elements |
Medium | medium.n_eff_profile | effective refractive index sequence | array[number] | 1 | aligned with path |
Reference | ref.c_ref | reference propagation limit | number | m/s | 2.9e8–3.1e8 |
Observation | obs.T_arr | arrival time | number | s | record delta_form |
Phase | obs.Phi | phase accumulation | number | rad | requires lambda_ref |
Band | lambda_ref | reference wavelength | number | m | paired with Phi |
Instrument | instrument.id / instrument.mode | device ID/mode | string | `imaging | spectral |
Calibration | calib.version / calib.timestamp | calibration version/time | string | SemVer / ISO-8601 | — |
Uncertainty | uncertainty.obs_T_arr / uncertainty.obs_Phi | standard uncertainty | number | s / rad | — |
Noise | noise.model | noise model | string | `gaussian | student |
Quality | quality.flags | quality flags | array[string] | — | e.g., sync_alert |
Quality | quality.score_Q | robust quality metric | number | [0,1] | lower is better |
Citations | see / references | in-text / external refs | array[string] | “volume+version+anchor” | ≥90% anchor coverage |
Version | version | data-object version | string | SemVer | — |
Checksum | checksum.sha256 | checksum | string | 64 hex | — |
II. see: / references[] (normative examples; text–data consistent)
see:
- "EFT.WP.Core.Equations v1.1:S20-1"
- "EFT.WP.Core.Metrology v1.0:check_dim"
- "EFT.WP.Core.DataSpec v1.0:TARR"
references:
- "EFT.WP.Core.Terms v1.0:P10-3"
version: "1.0.0"
In-text citation style: See "EFT.WP.Core.Equations v1.1" Ch.2 S20-1.
III. Template Pack (ready to commit)
A. manifest.yaml (release manifest)
dataset_id: "ptn-demo"
version: "1.0.0"
created_at: "2025-09-24T16:00:00Z"
producer: "PTN.Workgroup.Core"
see:
- "EFT.WP.Core.Equations v1.1:S20-1"
- "EFT.WP.Core.Metrology v1.0:check_dim"
- "EFT.WP.Core.DataSpec v1.0:TARR"
references:
- "EFT.WP.Core.Terms v1.0:P10-3"
checksum: { algo: "sha256", value: "<64-hex>" }
release_tier: "public"
B. schema.json (data schema, excerpt)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "PTN Data Object v1.0.0",
"type": "object",
"required": ["record_id","acq","path","medium","ref","obs","version","see","references"],
"properties": {
"record_id": { "type": "string" },
"acq": {
"type": "object",
"required": ["ts_start","ts_end"],
"properties": {
"ts_start": { "type": "string", "format": "date-time" },
"ts_end": { "type": "string", "format": "date-time" }
}
},
"path": {
"type": "object",
"required": ["gamma_ell","d_ell"],
"properties": {
"gamma_ell": { "type": "array", "items": { "type": "number" }, "minItems": 2 },
"d_ell": { "type": "array", "items": { "type": "number" }, "minItems": 2 }
}
},
"medium": {
"type": "object",
"required": ["n_eff_profile"],
"properties": {
"n_eff_profile": { "type": "array", "items": { "type": "number" }, "minItems": 2 }
}
},
"ref": {
"type": "object",
"required": ["c_ref"],
"properties": { "c_ref": { "type": "number", "minimum": 2.9e8, "maximum": 3.1e8 } }
},
"obs": {
"type": "object",
"properties": { "T_arr": { "type": "number" }, "Phi": { "type": "number" } }
},
"see": { "type": "array", "items": { "type": "string" }, "minItems": 1 },
"references": { "type": "array", "items": { "type": "string" }, "minItems": 1 },
"version": { "type": "string" }
}
}
C. pipeline.yaml (processing contract)
version: "1.0.0"
pipeline:
- id: step-10-ingest
in: ["raw/*.parquet"]
out: ["stage/ingested.parquet"]
checks: ["G1","G8"]
- id: step-20-calibrate
in: ["stage/ingested.parquet"]
out: ["stage/calibrated.parquet"]
checks: ["G5"]
- id: step-30-arrival"
in: ["stage/calibrated.parquet"]
out: ["stage/arrival.parquet"]
compute:
form: "T_arr = ( ∫ ( n_eff / c_ref ) d ell )"
requires: ["path.gamma_ell","path.d_ell","medium.n_eff_profile","ref.c_ref"]
delta_form: "general"
checks: ["G3","G4"]
- id: step-40-noisefit
in: ["stage/arrival.parquet"]
out: ["stage/denoised.parquet","reports/noise.json"]
model: "huber"
checks: ["G6"]
- id: step-50-exports
in: ["stage/denoised.parquet"]
out: ["PTN_EXPORT/"]
checks: ["G2","G4","G7"]
exports:
must_include: ["manifest.yaml","schema.json","check_dim_report.json","quality_report.json","audit.jsonl"]
D. protocol.yaml (Protocol Card)
version: "1.0.0"
protocol:
id: "ptn-exp-0001"
geometry:
frame: "RA-Dec"
r_hat: [<unit_vector>]
path:
gamma_ell: "<array-of-meters>"
d_ell: "<array-of-meters>"
L_min: 10.0
timebase: { fs_hz: 2000, t_exp_s: 0.01, cadence_s: 0.05 }
band: { lambda_ref_m: 1.55e-6, bandwidth_hz: 2.0e9, window: "hann" }
instrument: { id: "INS-001", mode: "timing" }
calibration:
version: "1.2.0"
timestamp: "2025-09-24T10:00:00Z"
freshness_s: 86400
sync: { ref: "GNSS_PPS", fallback: ["PTP","NTP"] }
gates: ["G1","G2","G3","G4","G5","G6","G7","G8"]
E. error_budget.csv (Error-Budget Card, headers)
source,symbol,unit,type,estimate,distribution,correlation,note,see[]
Absolute timing,δt_abs,s,A,u(δt_abs),approx-N,vs_channel_skew,,Core.Metrology v1.0
Path measure,d ell,m,B,u(d ell),uniform,with gamma(ell),,Core.DataSpec v1.0:TARR
Medium index,n_eff(ell),1,A/B,u(n_eff),GP(L_c),length L_c,,Core.Terms v1.0
F. scorecard.json (excerpt)
{
"version": "1.0.0",
"dataset_id": "ptn-demo",
"baseline": { "id": "base-001", "version": "1.2.3" },
"method": { "id": "mA-010", "version": "2.0.0" },
"metrics": {
"DeltaT_arr_s": { "mean": -2.3e-9, "std": 4.8e-9, "U_k2": 1.5e-9 },
"r_phi": { "value": 0.72, "ci95": [0.61, 0.80] },
"epsilon_flux": { "median": 0.004, "p95": 0.011 },
"p_dim": 1.0,
"Q_res": 0.13
},
"score": { "Q": 0.78 },
"see": [
"EFT.WP.Core.Equations v1.1:S20-1",
"EFT.WP.Core.Metrology v1.0:check_dim",
"Data.Benchmarks v1.0:PROTO"
],
"version_lock": true
}
IV. Canonical Snippets (paste-ready)
- Arrival time (two equivalent forms; explicit path & measure)
T_arr = ( ∫ ( n_eff / c_ref ) d ell ) = ( 1 / c_ref ) * ( ∫ n_eff d ell ) - Phase accumulation (with reference wavelength)
Phi = ( 2π / λ_ref ) ( ∫ n_eff d ell ) - Dimensional check (machine-readable)
call: "I70-dim_check"
expr: "T_arr = ∫ ( n_eff / c_ref ) d ell"
units: { n_eff: "1", c_ref: "m/s", d_ell: "m", T_arr: "s" }
expect: "closed"
- Forbidden bare symbols & conflict names
- Forbid bare c, T, n → use c_ref, specific quantity name (e.g., T_fil), and n_eff (or n).
- Do not mix T_fil (tension) with T_trans (transmittance); do not mix n (number density) with n_eff (effective refractive index).
V. Export Directory Layout (recommended for release)
PTN_EXPORT/
manifest.yaml
data/
observations.parquet
paths.parquet
schema/
schema.json
reports/
check_dim_report.json
quality_report.json
audit.jsonl
figs/
*.png
scorecard.json
results.md
SIGNATURE.asc
VI. Automation Config (Citation & Dim Lint)
lint_config.yaml
version: "1.0.0"
rules:
version_presence: 1.00
anchor_coverage: 0.90
path_measure_presence: 1.00
forbid_raw_symbols: ["c","T","n"]
conflict_pairs:
- ["T_fil","T_trans"]
- ["n","n_eff"]
dag_enforce: true
outputs:
report: "reports/citation_lint.json"
gate: "G2"
VII. Results Page Template (minimal, Markdown)
# PTN Results — v1.0.0
## 1. Summary
- One-liner; core metrics with uncertainty (ΔT_arr, r_phi, ε_flux, p_dim, Q_res).
## 2. Methods & Data
- dataset_id / method_id / baseline_id / versions / seeds.
## 3. Core Metrics
- ΔT_arr (s): mean±U, histogram, BA plot.
- r_phi: value + 95% CI; phase scatter vs identity.
- ε_flux: distribution; paraxial guard.
## 4. Compliance & Audit
- check_dim_report.json, audit.jsonl, see[], references[], version.
## 5. Figures
- PDF/PNG list with units & legends.
VIII. Terms & Symbols Registry (minimal, YAML)
version: "1.0.0"
symbols:
- { name: "c_ref", kind: "constant", unit: "m/s", desc: "reference propagation limit", see: ["EFT.WP.Core.Terms v1.0:P10-3"] }
- { name: "n_eff", kind: "variable", unit: "1", desc: "effective refractive index", see: ["EFT.WP.Core.Terms v1.0:P10-3"] }
- { name: "T_arr", kind: "variable", unit: "s", desc: "arrival time", requires: { path: "gamma(ell)", measure: "d ell" },
see: ["EFT.WP.Core.Equations v1.1:S20-1","EFT.WP.Core.Metrology v1.0:check_dim","EFT.WP.Core.DataSpec v1.0:TARR"] }
IX. One-Page Pre-Release Checklist
- In-text and data see[]/references[] use “volume+version+anchor”, with ≥90% anchor coverage.
- All path expressions explicitly show gamma(ell) and d ell, with delta_form recorded.
- p_dim = 1.0, τ_calib valid, clock_state = locked.
- Sampling meets Δell and f_s constraints; window and band declarations complete.
- Result bundle contains manifest.yaml / schema.json / check_dim_report.json / quality_report.json / audit.jsonl / scorecard.json.
- Bare c, T, n not used; T_fil vs T_trans, n vs n_eff not mixed.
Copyright & License (CC BY 4.0)
Copyright: Unless otherwise noted, the copyright of “Energy Filament Theory” (text, charts, illustrations, symbols, and formulas) belongs to the author “Guanglin Tu”.
License: This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0). You may copy, redistribute, excerpt, adapt, and share for commercial or non‑commercial purposes with proper attribution.
Suggested attribution: Author: “Guanglin Tu”; Work: “Energy Filament Theory”; Source: energyfilament.org; License: CC BY 4.0.
First published: 2025-11-11|Current version:v5.1
License link:https://creativecommons.org/licenses/by/4.0/