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

[develop] Pull in relevant doc updates from release v2.1.0 #498

Merged
merged 35 commits into from
Nov 29, 2022
Merged

[develop] Pull in relevant doc updates from release v2.1.0 #498

merged 35 commits into from
Nov 29, 2022

Conversation

gspetro-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

The documentation was thoroughly revised for the v2.1.0 release, and some of those updates are relevant to the develop branch. This PR adds those updates to develop.

Type of change

  • This change requires a documentation update (all documentation)

TESTS CONDUCTED:

None required. Reviewed the docs on my fork's Read the Docs site: https://srw-ug.readthedocs.io/en/text-updates/

DEPENDENCIES:

N/A.

DOCUMENTATION:

All documentation.

ISSUE:

Fixes issue #497 .

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). N/A
  • My changes generate no new warnings
  • New and existing tests pass with my changes (N/A - changes are text only)
  • Any dependent changes have been merged and published N/A

@MichaelLueken MichaelLueken linked an issue Nov 28, 2022 that may be closed by this pull request
Copy link
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.

@gspetro-NOAA I have some comments related to the changes to the plotting scripts, but otherwise, the documentation changes look good to me.

For the modification to the plotting scripts, was it decided that these changes weren't necessary? It sounded like a mismatch between grib2 field naming for Geopotential Height was causing the scripts to fail (leading to the changing of the name originally). If this is no longer an issue, then I'm fine with changing Geopotential height back to Geopotential Height.

Copy link
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.

@gspetro-NOAA Thanks for making the modifications to the plotting scripts! Approving the PR now.

Is this work ready to be merged, or would you like for more eyes to look over it before it is merged?

@gspetro-NOAA
Copy link
Collaborator Author

@gspetro-NOAA Thanks for making the modifications to the plotting scripts! Approving the PR now.

Is this work ready to be merged, or would you like for more eyes to look over it before it is merged?

@natalie-perlin wanted to take a look, so she's about to do that right now.

@MichaelLueken
Copy link
Collaborator

@gspetro-NOAA Thanks for making the modifications to the plotting scripts! Approving the PR now.
Is this work ready to be merged, or would you like for more eyes to look over it before it is merged?

@natalie-perlin wanted to take a look, so she's about to do that right now.

Thanks, @gspetro-NOAA! I will wait for @natalie-perlin approval before merging this work.

Copy link
Collaborator

@natalie-perlin natalie-perlin left a comment

Choose a reason for hiding this comment

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

Glossary.rst, add the following to the end of line 121:

Updated documentation could be found at :doc:HPC-Stack documentation <hpc-stack:index>.

Introduction.rst, change in line 9 (partial):

... New and improved capabilities for the v2.1.0 release included the addition of a verification package (METplus)...

Quickstart.rst, line 12 (partial) changes:

... (2) configuring the stack to specify compilers, compiler options, and installation directory and (3) specifying the software packages and versions to be built, and building the stack that downloads necessary repositories or archives to build the requested packages. This process will create a number of modulefiles needed to build SRW App.

@MichaelLueken
Copy link
Collaborator

@natalie-perlin and @gspetro-NOAA For the modification to Introduction.rst line 9, would it be better to remove:

New and improved capabilities for the v2.0.0 release included the addition of a verification package (METplus) for both deterministic and ensemble simulations and support for four stochastically perturbed physics schemes.

This sentence appears to be a carry over from release/public-v2, so it is no longer necessary for release/public-v2.1.0 and develop.

@gspetro-NOAA
Copy link
Collaborator Author

gspetro-NOAA commented Nov 28, 2022

@natalie-perlin I made the Glossary update. Also added the Quickstart changes with slight rewording, but it seems that if users are just installing the default HPC-Stack, they wouldn't have to specify packages. I say "At a minimum..." so I want to be sure that specifying packages IS actually a required step.
@MichaelLueken @natalie-perlin I would prefer to keep the Intro as is, since METplus and support for 4 physics suites (as opposed to 2) were significant improvements added in the v2.0.0 release and still present/applicable to the v2.1.0. I mentioned them in the past tense for users who are coming to this from the v1.x.x releases. Then switch to present tense for the current release's updates. I realize we're on develop, but since these changes reflect the most recent updates in develop, they give new users an idea of what the most recent progress/additions have included. I think when we get to a v3.0.0 release, we just replace that section with the new stuff. That was my thinking anyway.

@MichaelLueken
Copy link
Collaborator

@MichaelLueken @natalie-perlin I would prefer to keep the Intro as is, since METplus and support for 4 physics suites (as opposed to 2) were significant improvements added in the v2.0.0 release and still present/applicable to the v2.1.0. I mentioned them in the past tense for users who are coming to this from the v1.x.x releases. Then switch to present tense for the current release's updates.

@gspetro-NOAA This makes sense to me. Since this latest release is just a minor release, it is fine to keep the major updates from the version 2 major release in the introduction. I'm fine with keeping the introduction as it currently is in this PR.

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.

Pull in relevant doc updates from release v2.1.0
6 participants