Home ／ Docs-Technical WhitePaper ／ 22-EFT.WP.Metrology.Instrument v1.0
Appendix C — Manifest Templates & Examples (instrument manifest)
One-Sentence Objective
Provide the minimal key set, optional keys, and compliant examples for manifest.instrument, so that instrument metrology context is bound to data publication—supporting traceability, audit, and cross-system alignment.
I. Scope & Targets
- Covered scope: single-/multi-instrument acquisition sessions, metrology & calibration, timebase & synchronization, environmental conditions, quality dashboards, contract evaluation, and signature-backed traceability.
- Inputs/Outputs: inputs are acquisition artifacts and context; outputs are manifest.instrument (JSON or YAML), persisted per batch or per window Delta_t.
- Cross-references: arrival-time conventions in Metrology.TimeBase v1.0; sync servo in Metrology.Sync v1.0; statistical monitoring in Methods.CrossStats v1.0; cleaning contracts in Methods.Cleaning v1.0.
II. Naming & Versioning
- Version keys: manifest.name="instrument", manifest.version="1.0.0", schema="EFT.WP.Metrology.Instrument/manifest.instrument.v1".
- Event keys: TraceID, created_at (ISO 8601, UTC), producer, dataset_id.
- Compatibility semantics: major = breaking, minor = backward-compatible extension, patch = bug fix; consumers must tolerate unknown optional keys.
III. Key Spaces & Paths
- Namespaces: instrument.*, session.*, acq.*, timing.*, metrology.*, calibration.*, environment.*, contracts.*, panel.*, provenance.*, signature.*.
- Inline symbols: unit(x), dim(x), U = k * u_c, tau_mono, ts, offset/skew/J, T_arr, delta_form.
IV. Minimal Required Key Set
- TraceID: string (global traceability).
- manifest.{name,version,schema}: string.
- created_at: string (UTC ISO 8601).
- instrument.{id,make,model,sn}: string.
- session.{id,site,operator,start_ts,end_ts}: string.
- acq.ts_window.{start_ts,end_ts}: string; acq.mode: string; acq.channels[].{name,fs_Hz,bit_depth,input_range,units}.
- timing.{offset_s,skew_ppm,jitter_rms_s}; timing.sync.{method,gm_id,state}; timing.T_arr.{form1_s,form2_s,delta_form_s,tol_Tarr_s}.
- metrology.{unit_system,check_dim,U,k,u_c}.
- calibration.{certificate_id,issuer,si_chain[],scope[],valid_from,valid_to,TUR,status}.
- environment.RefCond.{T_C,RH_pct,pressure_hPa}.
- contracts.summary.pass_rate: number; contracts.items[C70-code].{status,ts,evidence[]}.
- panel.sli.{latency_ms_p99,error_rate,rho}.
- provenance.{hash_sha256,size_bytes,content_type,source_uris[]}.
- signature.{alg,kid,sig}.
V. Optional Keys (Scenario-Dependent)
- Linearity & noise: linearity.{INL_pp_LSB,DNL_pp_LSB,res_lin_RMS_LSB}; noise.{SNR_dB,ENOB,NF_dB,NEP_W_sqrtHz,psd_phi_ref}.
- Bandwidth & response: response.{f_3dB_Hz,ripple_pp,GD_pp_ns,overshoot_pct,settling_time_s}.
- Triggering & alignment: trigger.{type,level,holdoff_s,miss_rate,false_rate}; timing.skew_interch_ns.
- Cross-instrument harmonization: interlab.{bias,variance_ratio,W1}.
- Evidence links: attachments[].{name,uri,hash_sha256}.
VI. Event-Stream Persistence & Windowing
- Window keys: window.Delta_t_s, window.index, window.rollup (min|max|mean|p95|p99).
- Streaming convention: emit one manifest.instrument per Delta_t; contracts and panel use the same-window statistics; persistence order by tau_mono, external publication on ts.
VII. Template (JSON, minimal working skeleton)
VIII. Example (Multi-Instrument Joint Session + Key Optional Keys)
{
"TraceID": "4d1f6a7b-8e1a-4f2b-9c33-9b8a0f1e77cd",
"manifest": { "name": "instrument", "version": "1.0.0", "schema": "EFT.WP.Metrology.Instrument/manifest.instrument.v1" },
"created_at": "2025-09-01T13:30:00Z",
"producer": "fusion-node@site-B",
"dataset_id": "ds_20250901_B12",
"instrument": {
"id": "Fusion.Scope.DAQPair.B12",
"make": "EFT",
"model": "FusionPair",
"sn": "FP-00A1"
},
"session": { "id": "sess_1019", "site": "LAB-B", "operator": "op_li", "start_ts": "2025-09-01T13:00:00Z", "end_ts": "2025-09-01T14:00:00Z" },
"acq": {
"mode": "multi_instrument_sync",
"ts_window": { "start_ts": "2025-09-01T13:29:00Z", "end_ts": "2025-09-01T13:30:00Z" },
"channels": [
{ "name": "SCOPE.CH1", "fs_Hz": 2000000000, "bit_depth": 10, "input_range": "±0.5 V", "units": "V" },
{ "name": "DAQ.AI0", "fs_Hz": 1000000, "bit_depth": 16, "input_range": "±10 V", "units": "V" }
],
"trigger": { "type": "time", "level": 0.0, "holdoff_s": 0.0 }
},
"timing": {
"offset_s": -1.0e-7,
"skew_ppm": 1.5,
"jitter_rms_s": 5.0e-11,
"skew_interch_ns": 0.85,
"sync": { "method": "WhiteRabbit", "gm_id": "WR-DC-01", "state": "LOCKED" },
"T_arr": { "form1_s": 2.500001e-3, "form2_s": 2.500000e-3, "delta_form_s": 1.0e-9, "tol_Tarr_s": 2.0e-9 }
},
"metrology": { "unit_system": "SI", "check_dim": "pass", "U": 0.0015, "k": 2.0, "u_c": 0.00075 },
"calibration": {
"certificate_id": "CAL-FUSION-2025-07",
"issuer": "LAB-B.MET",
"si_chain": ["SI", "NMI", "LAB-B"],
"scope": ["voltage", "timebase", "frequency"],
"valid_from": "2025-07-15T00:00:00Z",
"valid_to": "2026-07-15T00:00:00Z",
"TUR": 6.1,
"status": "valid",
"attachments": [{ "name": "cal-pdf", "uri": "s3://bucket/cal/FUSION-2025-07.pdf", "hash_sha256": "a2b3..." }]
},
"environment": { "RefCond": { "T_C": 22.0, "RH_pct": 40.0, "pressure_hPa": 1010.5 }, "EMC": ["shielded_room"] },
"linearity": { "INL_pp_LSB": 0.8, "DNL_pp_LSB": 0.7, "res_lin_RMS_LSB": 0.2 },
"noise": { "SNR_dB": 60.5, "ENOB": 9.75, "NF_dB": 4.2 },
"response": { "f_3dB_Hz": 900000000, "ripple_pp": 0.012, "GD_pp_ns": 0.9, "overshoot_pct": 3.0, "settling_time_s": 2.2e-7 },
"contracts": {
"summary": { "pass_rate": 0.98 },
"items": {
"C70-003": { "status": "pass", "ts": "2025-09-01T13:30:01Z" },
"C70-041": { "status": "pass", "ts": "2025-09-01T13:30:02Z" },
"C70-112": { "status": "marginal", "ts": "2025-09-01T13:30:03Z", "evidence": ["panel://rho>0.8@slot2"] }
}
},
"panel": { "sli": { "latency_ms_p99": 180, "error_rate": 2e-5, "rho": 0.81 } },
"provenance": {
"hash_sha256": "77be0a...c9fd",
"size_bytes": 24117248,
"content_type": "application/x-parquet-bundle",
"source_uris": [
"s3://bucket/fusion/B12/scope-20250901.parquet",
"s3://bucket/fusion/B12/daq-20250901.parquet"
]
},
"signature": { "alg": "ed25519", "kid": "met-labB-key-2025", "sig": "Vg2Hh...1Pw=" }
}
IX. Pre-Publication Checks & Signature Flow (Mandatory)
- Run check_dim(expr) and perform unit normalization; write the result to metrology.check_dim.
- Compute the two T_arr forms and delta_form; assert delta_form ≤ tol_Tarr_s; persist under timing.T_arr.*; update contracts.items["C70-003"].
- Verify calibration certificates and the SI link; evaluate TUR and validity window; update calibration.status and contracts.items["C70-091"].
- Execute the C70-* contract suite; aggregate into contracts.summary.pass_rate and attach key evidence links.
- Compute panel.sli.* (window Delta_t and methods per the cleaning/panel spec); compare against SLOs and record alerts in contracts.items["C70-112"].
- Produce provenance.hash_sha256 and use signature.alg to sign both the manifest and the data manifest (paths, hashes, byte counts); write the signature to signature.sig.
X. Notes & Constraints
- Use English keys and SI units throughout; avoid mixing numeric fields with embedded unit strings—express units via contextual fields.
- Time is always UTC ISO 8601; internal computation on tau_mono, publication on ts, recorded at timing.{offset/skew/J}.
- Keys under contracts.items use standard codes (e.g., C70-041), with status ∈ {pass,marginal,fail}.
- For multi-instrument data, you must provide timing.skew_interch_ns and cross-instrument harmonization indicators.
XI. Cross-References
- Dual arrival-time forms and delta_form: Metrology.TimeBase v1.0, Chapter 9 and Appendix B.
- Sync implementation and White Rabbit: Metrology.Sync v1.0, Chapters 5/7/9.
- Contract codes and thresholds: Appendix B of this volume (C70 Suite).
- Statistical dashboards and drift: Methods.CrossStats v1.0, Chapter 14 and Appendix D.
Summary
This template provides the required minimal set, optional extensions, and two drop-in examples for manifest.instrument, meeting publication requirements for metrology, timebase, compliance, and traceability.
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/