generated from NOAA-GFDL/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add json schema for combined pp yaml #19
Draft
singhd789
wants to merge
2
commits into
main
Choose a base branch
from
add-pp-yaml-schema
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-06/schema#", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "name": { | ||
| "description": "The name of the experiment", | ||
| "type": "string" | ||
| }, | ||
| "platform": { | ||
| "description": "The platforms listed in the command", | ||
| "type": "string" | ||
| }, | ||
| "target": { | ||
| "description": "The targets listed in the command", | ||
| "type": "string" | ||
| }, | ||
| "build": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "compileYaml": { | ||
| "description": "Path to the compile yaml.", | ||
| "type": "string" | ||
| }, | ||
| "platformYaml": { | ||
| "description": "Path to the platform yaml.", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "directories": { | ||
| "description": "FRE shared directories", | ||
| "type": "object", | ||
| "items": {"$ref": "&/$defs/dirs"} | ||
| }, | ||
| "postprocess": { | ||
| "description": "FRE post-processing information", | ||
| "type": "object", | ||
| "items":{"$ref": "#/$defs/pp"} | ||
| } | ||
| }, | ||
| "$defs": { | ||
| "dirs": { | ||
| "history_dir": { | ||
| "description": "Diectory path to raw model output.", | ||
| "type":"string" | ||
| }, | ||
| "pp_dir": { | ||
| "description": "Directory path to post-processing output.", | ||
| "type":"string" | ||
| }, | ||
| "ptmp_dir": { | ||
| "description": "Directory to use for history file cache.", | ||
| "type":"string" | ||
| }, | ||
| "preanalysis_script":{ | ||
| "description": "Filepath to the user script.", | ||
| "type":["string","null"] | ||
| }, | ||
| "history_refined":{ | ||
| "description": "", | ||
| "type":["string","null"] | ||
| }, | ||
| "analysis_dir":{ | ||
| "description": "", | ||
| "type":["string","null"] | ||
| }, | ||
| }, | ||
| "pp": { | ||
| "type": "object", | ||
| "properties": { | ||
| "settings": { | ||
| "type:": "object", | ||
| "properties": { | ||
| "history_segment": { | ||
| "description": "Amount of time covered by a single history file (ISO8601 datetime)", | ||
| "type":"string" | ||
| }, | ||
| "site": { | ||
| "description": "", | ||
| "type":"string" | ||
| }, | ||
| "pp_chunk_a": { | ||
| "description": "Amount of time covered by a single postprocessed file (ISO8601 datetime).", | ||
| "type":"string" | ||
| }, | ||
| "pp_chunk_b": { | ||
| "description": "Secondary chunk size for postprocessed files, if desired (ISO8601 datetime). Divisble by pp_chunk_a.", | ||
| "type":"string" | ||
| }, | ||
| "pp_start": { | ||
| "description": "Start of the desired postprocessing (ISO8601 datetime).", | ||
| "type":"string" | ||
| }, | ||
| "pp_stop": { | ||
| "description": "End of the desired postprocessing (ISO8601 datetime)." | ||
| "type":"string" | ||
| }, | ||
| "pp_components": { | ||
| "description": "Space-separated list of user-defined components, discussed in more detail below." | ||
| "type":"string" | ||
| }, | ||
| "pp_grid_spec": { | ||
| "description": "Path to FMS grid definition tarfile." | ||
| "type":"string" | ||
| }, | ||
| "refine_diag_scripts": { | ||
| "description": "Path(s) to FMS grid definition tarfile." | ||
| "type":"array", | ||
| "items": {"type": "string"} | ||
| }, | ||
| } | ||
| }, | ||
| "switches": { | ||
| "type": "object", | ||
| "properties": { | ||
| "clean_work": { | ||
| "description": "Switch to remove intermediate data files when they are no longer needed.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_mdtf": { | ||
| "description": "Switch to run MDTF on generated pp output.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_statics": { | ||
| "description": "Switch to turn on/off statics processing.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_timeavgs": { | ||
| "description": "Switch to turn on/off time-average file generation.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_refinediag": { | ||
| "description": "Switch to run refine-diag script(s) on history file to generate additional diagnostics.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_atmos_plevel_masking": { | ||
| "description": "Switch to mask atmos pressure-level output above/below surface pressure/atmos top.", | ||
| "type":"boolean" | ||
| }, | ||
| "do_preanalysis": { | ||
| "description": "Switch to run a pre-analysis script on history files", | ||
| "type":"boolean" | ||
| }, | ||
| "do_analysis": { | ||
| "description": "Switch to launch analysis scripts", | ||
| "type":"boolean" | ||
| }, | ||
| "do_analysis_only": { | ||
| "description": "Switch to only launch analysis scripts", | ||
| "type":"boolean" | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "type": "array", | ||
| "properties": { | ||
| "type": { | ||
| "description": "Component name", | ||
| "type":"string" | ||
| }, | ||
| "sources": { | ||
| "description": "", | ||
| "type":"array", | ||
| "item": {"type": "string"} | ||
| }, | ||
| "sourceGrid": { | ||
| "description": "", | ||
| "type":"string" | ||
| }, | ||
| "xyInterp": { | ||
| "description": "", | ||
| "type":"string" | ||
| }, | ||
| "interpMethod": { | ||
| "description": "The interpolation method.", | ||
| "type":"string" | ||
| }, | ||
| "inputRealm": { | ||
| "description": "", | ||
| "type":"string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Dana, this looks great. Is it possible to define a custom "type" for the schema, do you know? That would be the best case scenario, if it were possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, I'm not sure. What would you want the type to be? Or do you mean custom as in it could be multiple types?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ISO8601 dates and durations would be great to validate, but seem hard to validate beyond "string". An enumerated list wouldn't quite work, since there are so many possibilities.
The way we "validate" the dates and durations now is attempt to parse it with
metomi.isodatetime.parsersand check if it succeeds or fails.It would be great to catch typos like "P1M"/"PM1" during validation, but it may not be possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I see. It does look like you can specify specific values: https://www.tutorialspoint.com/yaml/yaml_json_schema.htm
we can have a list of values that would work maybe
@J-Lentz might know more on this too!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regular expression matching would be really nice.. let's keep an eye out for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
aha!! Uriel coming in clutch in a previous commit he's done:
646e68c
https://json-schema.org/understanding-json-schema/reference/regular_expressions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fantastic. Enumerations and regular expressions are about all what we had for the XML schema, I think.