Skip to content

Various documentation fixes/improvements#2770

Merged
samsrabin merged 30 commits intoESCOMP:b4b-devfrom
samsrabin:docs-fixes-202409
Sep 26, 2024
Merged

Various documentation fixes/improvements#2770
samsrabin merged 30 commits intoESCOMP:b4b-devfrom
samsrabin:docs-fixes-202409

Conversation

@samsrabin
Copy link
Member

@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 or its infrastructure test: none No tests required (e.g. tools/contrib) 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
Closed
Delete User's Guide section about old PTCLMmkdata tool #2769
Closed
@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
Member Author

samsrabin commented Sep 20, 2024

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
wwieder
wwieder reviewed Sep 24, 2024
View reviewed changes
Copy link
Contributor

@wwieder wwieder left a comment

Choose a reason for hiding this comment

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

Thanks for making these updates, Sam. Some comments are mainly me realizing there is lots of documentation updates todo for CLM6. I'd avoid scope creep in this PR and merge things in to b4b-dev largely as-is.

@samsrabin
Update namelist_defaults_clm4_5.xml references.
318a312 
To namelist_definition_ctsm.xml
@samsrabin
namelist_defaults_|version|_tools.xml files no longer exist.
260c3c9
@samsrabin
Fix namelist XML refs in what-are-the-clm-tools.rst.
5d2ebe1
@samsrabin
Specify path to create_newcase.
9ed3cca
@samsrabin
Add TODOs to update refs to queryDefaultNamelist.pl.
f22f227
@samsrabin
Add TODOs to update refs to mksurfdata.pl.
8304414
@samsrabin
Fix compset and add TODO to "Running with historical CO2 forcing."
962a090
@samsrabin
TODO added in "Running with irrigation".
8a31077
@samsrabin
Add TODO about -bgc_spinup.
42ff69c
@samsrabin
Add TODOs about mkprocdata_map.
2bf912f
@samsrabin
Add TODOs about domain files not being needed in nuopc.
6ac23b2
@samsrabin
Add TODO about updating "Observational Sites Datasets".
5e75f2e
@samsrabin
Merge branch 'b4b-dev' into docs-fixes-202409
79f50f4 
# Conflicts:
#	python/ctsm/site_and_regional/mesh_plot_type.py
@samsrabin
Fix another namelist_definition_clm4_5.xml reference.
38598da
@samsrabin
More double-backticks in "Spinup of |version|-BGC-Crop".
a251582
@samsrabin samsrabin removed the PR status: awaiting review Work on this PR is paused while waiting for review. label Sep 24, 2024
@samsrabin samsrabin requested a review from wwieder September 24, 2024 17:48
@samsrabin samsrabin merged commit da386fe into ESCOMP:b4b-dev Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wwieder wwieder wwieder approved these changes

Assignees

@samsrabin samsrabin

Labels

bfb bit-for-bit documentation additions or edits to user-facing documentation or its infrastructure test: none No tests required (e.g. tools/contrib)

Projects

CTSM: Upcoming tags
Status: Done (non release/external)
CTSM6 documentation
Status: Done

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