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 plotting and template variable documentation #528

Merged
merged 17 commits into from
Jan 5, 2023
Merged

[develop]: Add plotting and template variable documentation #528

merged 17 commits into from
Jan 5, 2023

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Jan 4, 2023

DESCRIPTION OF CHANGES:

  • Added a plotting configuration section to RunSRW.rst
  • Deleted Graphics.rst (all relevant info has been added to RunSRW.rst) and removed/updated references to the Graphics chapter throughout the docs.
  • Updated ConfigWorkflow.rst with variables related to the addition of plotting to the workflow
  • Added chapter on Template Variables based on @gsketefian 's closed Issue Include documentation for using templates in the experiment configuration file #198. (Includes updates due to the switch to a python workflow and a concrete example (COMOUT_REF) from the plotting tasks.)

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

TESTS CONDUCTED:

None required (all documentation). I built the docs on my RTD account: https://srw-ug.readthedocs.io/en/text-plotting/index.html

Note that ReadTheDocs did dependencies updates on 1/26/22 and 1/4/23 that seem to be causing issues rendering bullet points properly. This will make any bulleted lists in our docs ugly, but the information is still there. I don't think the issue relates to anything I did, since the bullets are not rendering properly anywhere in the docs (including lists I didn't touch). There was also no problem with my RTD builds from 12/22/22.

  • hera.intel (out of the box case)

DEPENDENCIES:

N/A.

DOCUMENTATION:

All documentation.

ISSUE:

Issue #525
Issue #482
Issue #230

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

CONTRIBUTORS (optional):

@danielabdi-noaa @gsketefian @EdwardSnyder-NOAA

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 updating the plotting and template variable documentation! For the most part, everything looks great! I have noted a few minor spelling issues in ConfigWorkflow.rst.

docs/UsersGuide/source/ConfigWorkflow.rst Outdated Show resolved Hide resolved
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 I have one more comment, this time in RunSRW.rst - would it be best to replace $HOME with $SRW on line 566? In the BuildSRW chapter, it suggests that users create an environment variable pointing to their cloned SRW App and call it $SRW. It might be best to push for the use of this environment variable.

docs/UsersGuide/source/RunSRW.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 concerns! Approving this work now.

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

These documentation changes look good to me! Whatever is going on with the workflow for plotting is not related to the docs so approving!

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.

Add User's Guide documentation on how to use the plotting scripts in the workflow
4 participants