Home / Docs-Technical WhitePaper / 50-Parameter Registration Card Template v1.0
Chapter 12 — Appendices (Forms / Checklists / Templates)
I. Purpose & Scope
- Collect forms, checklists, machine-readable templates, and release skeletons for the full parameter registration workflow, aligned with Chapters 3–11; citations use “volume + version + anchor (P/S/M/I)”.
- For path quantities (arrival time/phase), explicitly show gamma(ell) and the measure d ell in text, and record delta_form ∈ {general, factored} in the card; public releases require p_dim = 1.0.
II. Appendix Index
A. Single card template param_card.yaml / Registry param_registry.csv / Schema params_schema.json
B. Path block template path_block.yaml (gamma/measure/delta_form)
C. Covariance groups & cross-group config cov_groups.yaml
D. Gate rules gate_rules.yaml / Validation response sample validate_response.json
E. Audit & release manifest audit.jsonl / report_manifest.yaml
F. OpenAPI snippet openapi.yaml (Schema & API)
G. One-page release layout & publish checklist
III. Single Card Template (YAML)
version: "1.0.0"
param_id: "CAL-01-τ_sys"
name: "system_delay"
symbol: "τ_sys"
domain:
type: "real"
unit: "s"
range: [0, 1e-3]
default: 1.0e-6
precision: "float64"
lineage:
source_type: "measured" # measured|derived|configured
method: "loopback"
instrument: "DPO-7k"
calib_run_id: "CAL2025-09-24-01"
freshness:
valid_from: "2025-09-24T00:00:00Z"
valid_to: "2025-10-24T00:00:00Z"
policy: { tau_calib_s_max: 86400, clock_state: "locked" }
uncertainty:
type: "A"
estimate: 2.0e-8
distribution: "normal"
coverage: { k: 2 }
cov_group: "timing"
constraints:
depends_on: ["ENV-02-ΔT"]
derived: ""
status: "stable" # draft|stable|deprecated
see:
- "EFT.WP.Core.Metrology v1.0:check_dim"
references: []
Registry (CSV header)
param_id,name,symbol,domain.type,domain.unit,domain.range_min,domain.range_max,domain.default,precision,cov_group,status,version
params_schema.json (excerpt)
{
"$schema":"https://json-schema.org/draft/2020-12/schema",
"title":"param_card v1.0.0",
"type":"object",
"required":["param_id","symbol","domain","status","version","see"],
"properties":{
"param_id":{"type":"string","pattern":"^[A-Z]{3}-\\d{2}(-[A-Za-z_]{1,16})?$"},
"symbol":{"type":"string"},
"domain":{"type":"object","required":["type","unit"]},
"lineage":{"type":"object"},
"freshness":{"type":"object"},
"uncertainty":{"type":"object"},
"cov_group":{"type":"string"},
"constraints":{"type":"object"},
"path":{"type":"object"},
"status":{"enum":["draft","stable","deprecated"]},
"see":{"type":"array","items":{"type":"string"},"minItems":1},
"version":{"type":"string"}
}
}
IV. Path Block Template
path:
gamma: "gamma(ell)" # explicit path
measure: "d ell" # explicit measure
delta_form: "general" # general|factored
meta:
delta_ell: 0.25 # sampling step (m), example
notes: "Show gamma/measure in text; record delta_form in card."
V. Covariance Group Config
version: "1.0.0"
cov_groups:
timing:
kernel: "ar1" # exp|matern|ar1|const
params: { sigma2: 4.0e-16, phi: 0.85 }
medium:
kernel: "exp"
params: { sigma2: 9.0e-6, L_c_m: 25.0 }
cross_covar:
- pair: ["medium","env"]
rule: "const_rho"
params: { rho: 0.25 }
VI. Gates & Validate
gate_rules.yaml
version: "1.0.0"
gates:
G1: { schema_required: ["param_id","symbol","domain","status","version","see"] }
G2: { anchor_coverage_min: 0.90, forbid_external_links: true }
G3: { path_required: true, min_samples: 2, delta_form: ["general","factored"] }
G4: { require_dim_check: true, p_dim: 1.0 }
G5: { tau_calib_s_max: 86400, clock_state: "locked" }
G6: { require_uncertainty: true, coverage_allowed: ["k","alpha","quantile"] }
G7: { cov_pd: true, kernel_allowed: ["exp","matern","ar1","const"] }
G8: { unique_param_id: true, unique_checksum: true, lineage_acyclic: true }
stops:
S1: "dim_check_fail or p_dim<1"
S2: "freshness_expired or clock_state!=locked"
S3: "path_block_missing"
S4: "covariance_not_pd or cov_model_mismatch"
S5: "anchor_coverage_below_min or external_link_found"
labels: { restricted: "[Restricted]" }
validate_response.json
{
"param_id":"PHY-03-n_eff_profile",
"version":"1.0.0",
"gates":{"G1":true,"G2":0.94,"G3":true,"G4":true,"G5":true,"G6":true,"G7":true,"G8":true},
"stops_triggered":[]
}
VII. Audit & Release
audit.jsonl (sample line)
{"ts":"2025-09-24T16:10:00Z","event":"locked","param_id":"CAL-01-τ_sys",
"version":"1.1.0","user":"release-bot","input_hashes":["sha256:..."],
"notes":"lock for release","signature":"PGP:...","checksum":"sha256:..."}
report_manifest.yaml
version: "1.0.0"
bundle:
cards: ["cards/param_card.yaml"]
tables: ["tables/param_registry.csv"]
reports: ["reports/check_dim_report.json","reports/audit.jsonl"]
figures: []
metadata:
dataset_id: "ptn-demo"
method_version: "2.0.0"
checksums: ["sha256:..."]
see:
- "EFT.WP.Core.Metrology v1.0:check_dim"
VIII. OpenAPI Snippet (Schema & API)
openapi: 3.0.3
info: { title: "Param Registry API", version: "1.0.0" }
servers: [{ url: "https://registry.example.com/api/v1" }]
paths:
/params: { get: { summary: "List cards" }, post: { summary: "Register/Update card" } }
/params/{param_id}: { get: { summary: "Get card" } }
/params/{param_id}/validate: { post: { summary: "Validate gates & schema" } }
/params/{param_id}/lock: { post: { summary: "Lock version" } }
components:
schemas:
ParamCard: { $ref: "#/components/schemas/ParamCard" }
IX. Release Layout (Recommended)
PTN_EXPORT/
cards/
param_card.yaml
tables/
param_registry.csv
reports/
check_dim_report.json
audit.jsonl
schemas/
params_schema.json
configs/
gate_rules.yaml
cov_groups.yaml
report_manifest.yaml
SIGNATURE.asc
X. One-Page Publish Checklist
- Text & data see[]/references[] use “volume+version+anchor”; anchor coverage ≥ 90%, no external links/aliases.
- For path quantities, explicit gamma(ell)/d ell; card records delta_form; len(path) ≥ 2, Δell compliant; p_dim = 1.0.
- param_card.yaml/json, param_registry.csv, params_schema.json, audit.jsonl, report_manifest.yaml, and signature are complete.
- gate_rules.yaml consistent with /validate response; version lock executed (when applicable).
- cov_group/cov_model consistent with the Error Budget; coverage conventions aligned with publication tables.
- Directory structured as specified, no loose files; all artifacts have checksum.
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/