Skip to content
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

Merged
merged 6 commits into from
Jul 13, 2023
Merged

Yaml update #1269

merged 6 commits into from
Jul 13, 2023

Conversation

uramirez8707
Copy link
Contributor

Description
Removes the need for freq_units, new_file_freq_units, and file_duration_units by allowing freq, new_file_freq, and file_duration to accept both.
The tests and the documentation were also updated.

Fixes # (issue)

How Has This Been Tested?
CI

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules
  • New check tests, if applicable, are included
  • make distcheck passes

diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Show resolved Hide resolved
diag_manager/fms_diag_yaml.F90 Show resolved Hide resolved
Copy link
Contributor

@ganganoaa ganganoaa left a 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.

diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
diag_manager/README.md Outdated Show resolved Hide resolved
Copy link
Member

@thomas-robinson thomas-robinson left a 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

Comment on lines 65 to 71
- **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.
Copy link
Member

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.

@thomas-robinson thomas-robinson merged commit 9e82c4b into NOAA-GFDL:dmUpdate Jul 13, 2023
@uramirez8707 uramirez8707 deleted the yaml_update branch August 24, 2023 18:44
rem1776 pushed a commit to rem1776/FMS that referenced this pull request May 1, 2024
 documentation update
rem1776 pushed a commit to rem1776/FMS that referenced this pull request May 1, 2024
 documentation update
rem1776 pushed a commit to rem1776/FMS that referenced this pull request May 1, 2024
rem1776 pushed a commit to rem1776/FMS that referenced this pull request May 1, 2024
rem1776 pushed a commit to rem1776/FMS that referenced this pull request May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants