inital version for experiment YAML template and JSON schema - #460
Merged
Conversation
korbinib
added
enhancement
Removed unnecessary required fields from the experiment schema.
Collaborator
Author
|
@MagnusSletten could you review this PR? |
korbinib
marked this pull request as ready for review
February 17, 2026 09:07
Collaborator
Yeah, that should be fine! I'll look at it later today 👍 |
MagnusSletten
left a comment
MagnusSletten
left a comment
Collaborator
There was a problem hiding this comment.
Nice work! Couple of very minor comments, many of them are completely optional to change.
comcon1
requested changes
Feb 21, 2026
Comment on lines
+98
to
+99
| "PH", | ||
| "PH_METHOD" |
Member
There was a problem hiding this comment.
PH_METHOD is required only if PH is not UNKNOWN
| "properties": { | ||
| "T_RF_HEATING": {"type": "string"}, | ||
| "INSTRUMENT": {"type": "string"}, | ||
| "METHOD": {"type": "string"}, |
Member
There was a problem hiding this comment.
For this field we have a specific list. This is what AI wrote for me:
"METHOD": {
"type": "string",
"description": "Field identifying the NMR method used (formatted as METHOD:SUBMETHOD, e.g., '2H:QE').",
"examples": [
"2H:SP",
"2H:QE",
"CDLF:REDOR",
"CDLF:DIPSHIFT",
"CDLF:recDIPSHIFT",
"PDLF:DROSS",
"PDLF:R18_1^7",
"PDLF:see_comments"
],
"pattern": "^(2H:(SP|QE|see_comments)|CDLF:(REDOR|DIPSHIFT|recDIPSHIFT|see_comments)|PDLF:(DROSS|R[0-9]+(_[0-9]+)?\\^[0-9]+|see_comments))$"
}| "properties": { | ||
| "SOURCE": {"type": "string"}, | ||
| "LAMBDA": {"type": "string"}, | ||
| "QRANGE": {"type": "number"}, |
Member
There was a problem hiding this comment.
qrange is a range, not a number
| "description": "X-ray Specific Metadata", | ||
| "properties": { | ||
| "SOURCE": {"type": "string"}, | ||
| "LAMBDA": {"type": "string"}, |
Member
There was a problem hiding this comment.
This is a number, because it's a wavelength
Updated comments and corrected typos in the experiment template schema.
Changed LAMBDA type from string to number for accuracy.
Updated the experiment schema and modified required fields based on conditions.
Collaborator
Author
comcon1
reviewed
Feb 23, 2026
comcon1
left a comment
comcon1
left a comment
Member
There was a problem hiding this comment.
I found a small comment. Have you tried to run the validation over the real DB?
Co-authored-by: Korbinian Bösl <korbinian.bosl@uib.no>
comcon1
approved these changes
Feb 24, 2026
Collaborator
Author
|
I would merge but it will complain about all the information according to the old schema. e.g.: |
comcon1
requested changes
Feb 24, 2026
comcon1
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This will partially address #459 .
Adding the schema for experiments.
📚 Documentation preview 📚: https://databank--460.org.readthedocs.build/