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]: Add Tutorial chapter to SRW App Documentation #584

Merged
merged 16 commits into from
Feb 9, 2023

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Feb 7, 2023

DESCRIPTION OF CHANGES:

This PR adds a Tutorial chapter to the SRW Documentation. There are descriptions for 5 severe weather events and a full tutorial for the first one (2019061518).
This PR also includes:

  • Updates to the Glossary
  • An introduction to SSH and scp data transfer, which will help users to download tutorial plots from HPC systems to their local system for viewing.
  • Minor fixes/updates in other chapters for spelling/grammar/accuracy.

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required. Docs can be viewed on my fork at https://srw-ug.readthedocs.io/en/text-tutorial/Tutorial.html# Formerly, tests were run on the following systems:

  • hera.intel
  • orion.intel
  • cheyenne.intel
  • cheyenne.gnu
  • gaea.intel
  • jet.intel
  • wcoss2.intel
  • NOAA Cloud (AWS)

Since this is the reintroduction of a previously-approved PR, no further testing has been done.

DEPENDENCIES:

N/A

DOCUMENTATION:

All documentation.

ISSUE:

Issue #550
Issue #588

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 N/A
  • Any dependent changes have been merged and published

@MichaelLueken MichaelLueken linked an issue Feb 9, 2023 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 Thank you very much for recreating a PR to get the Tutorial chapter back into develop without the binary files!

In PR #562, @mkavulich added information about the behavior of setting EXPT_BASEDIR as a relative path. It was noted that this information was removed in ConfigWorkflow.rst as part of this PR. Please add these sentences back in.

Once this has been addressed, I'm ready to approve.

docs/UsersGuide/source/ConfigWorkflow.rst Outdated Show resolved Hide resolved
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 Thank you very much for addressing my concern! Approving these changes now.

Copy link
Collaborator

@mkavulich mkavulich left a comment

Choose a reason for hiding this comment

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

Gillian, thanks again for being so flexible with the hassle of this re-do process. Just two minor suggestions, everything else looks great.

docs/UsersGuide/source/Glossary.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/Glossary.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/Tutorial.rst Show resolved Hide resolved
@MichaelLueken MichaelLueken merged commit 3de08b0 into ufs-community:develop Feb 9, 2023
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.

Tutorial chapter was deleted in Git history revision
4 participants