Skip to content

Conversation

@slevis-lmwg
Copy link
Contributor

@slevis-lmwg slevis-lmwg commented May 29, 2025

Description of changes

I started with the README.md already available in /mksurfdata_esmf to update the relevant documentation file.

Specific notes

Contributors other than yourself, if any:

CTSM Issues Fixed (include github issue #):
Resolves #1718

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

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

Testing performed, if any:
The build worked on my Windows laptop, but the browser would not open for me to evaluate the outcome. I was working in an .\slevisadmin space on Ubuntu, so next I should make a new clone in the non-admin Ubuntu space when I get back to updating and testing this work.

@slevis-lmwg slevis-lmwg self-assigned this May 29, 2025
@slevis-lmwg slevis-lmwg added the docs:update Significant update or fix needed to existing documentation label May 29, 2025
@samsrabin samsrabin added docs-loc:users-guide Relates to User's Guide (using CTSM/tools) bfb bit-for-bit labels May 29, 2025
@samsrabin samsrabin changed the base branch from master to b4b-dev May 30, 2025 03:40
@slevis-lmwg
Copy link
Contributor Author

@slevis-lmwg note to self: Reminder to also see my updates from a while ago (2023/12/5) to
/doc/source/users_guide/using-clm-tools/what-are-the-clm-tools.rst
in my local branch documentation_wk located in /fs/cgd/data0/slevis/git/latest_master_new.

@samsrabin samsrabin marked this pull request as draft June 2, 2025 17:00
@samsrabin
Copy link
Member

@slevis-lmwg Marking this as draft since it seems like it's still in progress. Please undo that if I'm wrong.

@slevis-lmwg
Copy link
Contributor Author

Since I may not look at this for a little while...
My attempt to build the docs gave these errors and warnings in the file that I modified:

/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:95: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:93: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:96: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:96: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:96: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:102: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:100: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:103: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:103: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:103: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:121: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:119: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:125: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:125: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:125: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:131: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:129: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:132: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:132: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:132: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:138: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:136: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:139: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:139: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:139: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:154: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:152: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:156: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:156: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:156: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:163: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:168: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:166: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:170: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:170: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:170: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:177: ERROR: Unexpected indentation. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:175: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:179: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:179: WARNING: Inline literal start-string without end-string. [docutils]
/home/user/mounted_home/doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst:179: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]

@samsrabin
Copy link
Member

samsrabin commented Jun 9, 2025

One way to make this simpler is to just embed the Markdown file rather than copying it in: slevis-lmwg#18

I agree with @samsrabin I think we should bring in the README file in the embeded way, so that we only have to make changes in one place. This will be easier for maintence. The user's guide could have something additional, and maybe some figures that aren't in the README, but should be supplementary to the README.

@samsrabin samsrabin force-pushed the doc_mksurfdata_esmf branch from ff0c3ca to 42098c5 Compare June 9, 2025 17:31
@ekluzek ekluzek added this to the cesm3.0.0 release branch tag milestone Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bfb bit-for-bit docs:update Significant update or fix needed to existing documentation docs-loc:users-guide Relates to User's Guide (using CTSM/tools)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Change user's guide to document how to use the new mksurfdata_esmf tool

3 participants