Schema Documentation
Version: 0.0.2
Schema for validating YAML metadata embedded in NMR pulse program files
Required Fields
| Field |
Type |
Description |
schema_version |
string |
Version of this annotation schema |
sequence_version |
string |
Semantic version of the pulse sequence |
title |
string |
Short, descriptive sequence name |
authors |
array |
List of sequence authors |
created |
string |
Creation date in YYYY-MM-DD format |
last_modified |
string |
Last modification date in YYYY-MM-DD format |
repository |
string |
Repository identifier (e.g., github.com/user/repo) |
status |
string |
Development/validation status |
experiment_type |
array |
Array of experiment type keywords (see VOCABULARY.md) |
Optional Fields
| Field |
Type |
Description |
features |
array |
Array of feature keywords (see VOCABULARY.md) |
typical_nuclei |
array |
Typical nuclei for this sequence, ordered by spectrometer channel (f1, f2, f3, ...). Use 'nothing' for unused channels. |
description |
string |
Detailed description of the sequence |
citation |
array |
Literature citations |
doi |
array |
DOI identifiers for related publications |
dimensions |
array |
List of dimension identifiers using dotted path notation (e.g., relaxation.duration, f1) |
acquisition_order |
array |
Acquisition loop order from innermost to outermost using dimension names |
reference_pulse |
array |
Reference pulse calibrations for power calculations |
Controlled Vocabularies
Status Values
| Value |
Description |
experimental |
- |
beta |
- |
stable |
- |
deprecated |
- |