Skip to content

[develop] Update Build/Run and ConfigWorkflow Chapters#425

Merged
MichaelLueken merged 66 commits into
ufs-community:developfrom
gspetro-NOAA:text/releaseprep
Oct 31, 2022
Merged

[develop] Update Build/Run and ConfigWorkflow Chapters#425
MichaelLueken merged 66 commits into
ufs-community:developfrom
gspetro-NOAA:text/releaseprep

Conversation

@gspetro-NOAA
Copy link
Copy Markdown
Collaborator

@gspetro-NOAA gspetro-NOAA commented Oct 24, 2022

DESCRIPTION OF CHANGES:

  • Updated ConfigWorkflow chapter variables & descriptions
  • Added variable descriptions to config_defaults.yaml that were accidentally deleted during the .sh --> .yaml switch
  • Separated the BuildRunSRW chapter into two chapters: BuildSRW and RunSRW.
  • Removed regional_workflow directory references in ConfigWorkflow, BuildSRW, and RunSRW.
  • Adjusted file names in the 3 chapters above to .py or .yaml (rather than .sh). (I have updated in other chapters, too, but may have missed spots and will review those other chapters again before the release.)
  • Updated internal and external crossreferences.

Type of change

  • This change requires a documentation update (it IS a doc update)

TESTS CONDUCTED:

None required. Built docs on my ReadTheDocs account. They can be viewed here:

DEPENDENCIES:

None.

DOCUMENTATION:

Everything is docs! :)

ISSUE:

Partially addresses Issue #392 .
Addresses Issue #426.

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • [] I have commented my code, particularly in hard-to-understand areas (N/A)
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes (no tests required)
  • Any dependent changes have been merged and published (N/A)

CONTRIBUTORS (optional):

@danielabdi-noaa

gspetro and others added 30 commits September 26, 2022 13:30
Comment thread docs/UsersGuide/source/RunSRW.rst Outdated
Comment thread docs/UsersGuide/source/RunSRW.rst Outdated
Comment thread docs/UsersGuide/source/RunSRW.rst Outdated
@gspetro-NOAA
Copy link
Copy Markdown
Collaborator Author

gspetro-NOAA commented Oct 28, 2022

@danielabdi-noaa @christinaholtNOAA @chan-hoo Could you take a look at the updated workflow generation image (docs/UsersGuide/source/_static/SRW_regional_workflow_gen.png) to see what else I should change? I think the PRs from the past few days might require an update to the image. Couldn't hurt to look at the other PNG images either.
You can see the RTD version here.

Comment thread docs/UsersGuide/source/BuildSRW.rst Outdated
@danielabdi-noaa
Copy link
Copy Markdown
Collaborator

@danielabdi-noaa @christinaholtNOAA @chan-hoo Could you take a look at the updated workflow generation image (docs/UsersGuide/source/_static/SRW_regional_workflow_gen.png) to see what else I should change? I think the PRs from the past few days might require an update to the image. Couldn't hurt to look at the other PNG images either. You can see the RTD version here.

@gspetro-NOAA You may want to do this if it not too much trouble to re-create the figures.

For the first figure:

  • Add a {machine_config}.yaml in between config_defaults.yaml and config.yaml
  • set_extrn_mdl_param.py function is now removed because it was a one-line function.

For the other figure, the names of J-jobs and ex-scripts were made to be consitstent for NCO mode so some of the script file names are updated

- `exregional_get_ccpa_files.sh` -> `exregional_get_obs_ccpa.sh`
- `exregional_get_mrms_files.sh` -> `exregional_get_obs_mrms.sh`
- `exregional_get_ndas_files.sh` -> `exregional_get_obs_ndas.sh`
- `exregional_run_gridstatvx.sh` -> `exregional_run_vx_gridstat.sh`
- `exregional_run_pointstatvx.sh` -> `exregional_run_vx_pointstat.sh`

@gspetro-NOAA
Copy link
Copy Markdown
Collaborator Author

gspetro-NOAA commented Oct 28, 2022

@danielabdi-noaa Updated images! Do I need to add fixed_files_mapping.yaml anywhere?

@danielabdi-noaa
Copy link
Copy Markdown
Collaborator

@gspetro-NOAA Thanks, It looks good to me! I don't think you need to explain fixed_file_mapping.yaml since it is now part of parm which has many other files like that.

Copy link
Copy Markdown
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation update looks good to me! Thank you very much, @gspetro-NOAA, for addressing all of the comments that have been made!

@MichaelLueken
Copy link
Copy Markdown
Collaborator

Please take the opportunity to review these changes as soon as possible. These are necessary for code slush. If everything looks good, please give your approval. If you have any questions or concerns, please make note of them. Thank you very much for your time!

Copy link
Copy Markdown
Collaborator

@danielabdi-noaa danielabdi-noaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gspetro-NOAA, it looks good to me so approving!

@MichaelLueken MichaelLueken merged commit 0e11b9d into ufs-community:develop Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants