-
Notifications
You must be signed in to change notification settings - Fork 136
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
Yaml update #1269
Yaml update #1269
Conversation
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.
Looks good other than some required changes.
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.
Just a documentation update
diag_manager/README.md
Outdated
- **file_name** is a string that defines the name of the file. Do not add ".nc" and "tileX" to the filename as this will be handled by FMS. | ||
- **freq** is a string that defines the frequency and the units that data will be written | ||
- The acceptable values for freq are: | ||
- =-1: output at the end of the run only | ||
- =0: output every timestep | ||
- \>0: output frequency and units (with a space between the frequency number and units e.g 24 hours) | ||
- The acceptable values for units are seconds, minutes, hours, days, months, years. |
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.
If -1 and 0 don't need units, then this section should be a little bit clearer. It should specifically include the units with the value and explicitly state that units are not needed for -1 and 0.
- The acceptable values for freq are:
- =-1: output at the end of the run only
- =0: output every timestep
- >0 units: output frequency and units (with a space between the frequency number and units e.g 24 hours)
Values of -1 or 0 do not require units.
documentation update
documentation update
Description
Removes the need for
freq_units
,new_file_freq_units
, andfile_duration_units
by allowingfreq
,new_file_freq
, andfile_duration
to accept both.The tests and the documentation were also updated.
Fixes # (issue)
How Has This Been Tested?
CI
Checklist:
make distcheck
passes