Streamline Hurricane Matthew use case documentation

[briannen]

Describe the Enhancement

At the request of @jaredalee, the Hurricane Matthew use case documentation should be put into one section (e.g. 6.1) and the sections describing how to run on different systems should be put in subsections (e.g. 6.1.1, etc.)

Plan to do this testing on jetstream2:

• Request access and login to jetstream2
• Run through existing instructions there
• Create a feature branch of the current main branch
• Revise the instructions to reorganize and clarify them as needed

Time Estimate

1 day or less

Sub-Issues

Consider breaking the enhancement down into sub-issues.

• Add a checkbox for each sub-issue here.

Relevant Deadlines

NONE

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Select component(s)
• Select priority
• Select requestor(s)

Projects and Milestone

• Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
• Select Milestone as the next official version or Future Versions

Enhancement Checklist

• Complete the issue definition above, including the Time Estimate and Funding Source.
• Fork this repository or create a branch of develop.
  Branch name: feature_<Issue Number>_<Description>
• Complete the development and test your changes.
• Add/update log messages for easier debugging.
• Add/update unit tests.
• Add/update documentation.
• Push local changes to GitHub.
• Submit a pull request to merge into develop.
  Pull request: feature <Issue Number> <Description>
• Define the pull request metadata, as permissions allow.
  Select: Reviewer(s) and Development issues
  Select: Repository level development cycle Project for the next official release
  Select: Milestone as the next official version
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.

[JohnHalleyGotway]

Example commands for creating and working on a feature branch.

cd i-wrf
git clone https://github.com/NCAR/i-wrf feature_63_hurricane_matthew_docs
# Or with SSH keys setup: git clone git@github.com:NCAR/i-wrf feature_63_hurricane_matthew_docs
cd feature_63_hurricane_matthew_docs
git branch
# Prints *main as the default
# Create/checkout a new branch of main
git checkout -b feature/63_hurricane_matthew_docs
# Push new branch up to GitHub
git push -u origin feature/63_hurricane_matthew_docs
# Make updates to the docs in docs/Users_Guide
git status
# To see what local mods you have
git add .
# To stage files for commit
git status # See files staged for commit in green
git commit -m "Per #63, add some description of the changes"
git push
# To push local changes back up to GitHub
# Can delete branches in GitHub at this link https://github.com/NCAR/i-wrf/branches
git fetch
# Pulls updates from github into you local copy of the repo
git diff
# Shows local modifications relative to your local branch
git diff origin/main
# Shows local modifications relative to the default main branch
git merge origin/main
# Merges all recent changes to the main branch into your feature branch
git push
# Pushes the result of the merge back up to GitHub

Please see https://github.com/NCAR/i-wrf/blob/main/docs/requirements.txt to build the RTD content locally with cd docs ; make html ; open _build/html/index.html

[briannen]

Here is a screenshot of what this looks like (see section 6.2).