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.

Sign up for GitHub

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

Jump to bottom

Various documentation fixes/improvements #2770

Open
wants to merge 13 commits into
base: b4b-dev
Choose a base branch
from
Open

Various documentation fixes/improvements #2770

wants to merge 13 commits into from

Conversation

samsrabin
Copy link
Collaborator

@samsrabin samsrabin commented Sep 17, 2024 •
edited
Loading

Description of changes

  • Removes User's Guide section about old PTCLMmkdata tool
  • Improves User's Guide page about using mesh_maker
  • Various formatting, typo, etc. improvements.

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed (include github issue #):

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? ...yes?

Testing performed, if any:

  • Before merging, ensure that no build errors have been introduced

Remaining tasks

how-to-make-mesh.rst:

  • Add instructions for using mesh_plotter
  • Add 5x5_amazon figures from mesh_plotter
  • Test mesh file in a CTSM run to make sure it works

General

  • Build HTML and push to docs repo

@samsrabin samsrabin added documentation additions or edits to user-facing documentation no testing required ONLY changes scripts in the "contributor" area or documentation changes that don't require testing bfb bit-for-bit labels Sep 17, 2024
@samsrabin samsrabin self-assigned this Sep 17, 2024
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone Sep 17, 2024
@samsrabin samsrabin changed the base branch from b4b-dev to master September 17, 2024 23:12
@samsrabin samsrabin changed the base branch from master to b4b-dev September 17, 2024 23:12
@samsrabin
Move how-to-make-mesh.md to the User's Guide; give extension .rst.
d6a2047 
Also makes it accessible from table of contents. Not actually changing file contents at this point.
@samsrabin
how-to-make-mesh: Markdown to RestructuredText.
f84c5b7
@samsrabin
Improve mesh_maker instructions.
2a6ed6d 
* The experience of making a mesh from an input with 1d vs. 2d coordinates is identical, so only provide one example.
* In example, use as input file the 5x5_amazon surface dataset included with CTSM.
* Various wording and typo fixes.
@samsrabin samsrabin added the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Sep 19, 2024
@wwieder wwieder removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Sep 19, 2024
This was linked to issues Sep 19, 2024
Fixes needed to mesh_maker.py instructions #2489
Open
Delete User's Guide section about old PTCLMmkdata tool #2769
Open
@samsrabin samsrabin changed the title [WIP] Various documentation fixes/improvements Various documentation fixes/improvements Sep 20, 2024
@samsrabin samsrabin marked this pull request as ready for review September 20, 2024 02:31
@samsrabin
Copy link
Collaborator Author

ctsm-docs PR: ESCOMP/ctsm-docs#7.

@samsrabin samsrabin added the PR status: awaiting review Work on this PR is paused while waiting for review. label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@samsrabin samsrabin

Labels
bfb bit-for-bit documentation additions or edits to user-facing documentation no testing required ONLY changes scripts in the "contributor" area or documentation changes that don't require testing PR status: awaiting review Work on this PR is paused while waiting for review.
Projects
CTSM6 documentation
Status: In Progress
CTSM: Upcoming tags
Status: In progress - master/b4b-dev
Milestone
ctsm6.0.0 (code freeze)
Development

Successfully merging this pull request may close these issues.

Delete User's Guide section about old PTCLMmkdata tool Fixes needed to mesh_maker.py instructions
2 participants
@samsrabin @wwieder