Skip to content

Update documentation for generating fsurdat/landuse files - #3199

Merged
slevis-lmwg merged 28 commits into
ESCOMP:b4b-devfrom
slevis-lmwg:doc_mksurfdata_esmf
May 8, 2026
Merged

Update documentation for generating fsurdat/landuse files#3199
slevis-lmwg merged 28 commits into
ESCOMP:b4b-devfrom
slevis-lmwg:doc_mksurfdata_esmf

Conversation

@slevis-lmwg

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

Copy link
Copy Markdown
Contributor

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
Resolves #3478

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:

@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) b4b 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
Copy Markdown
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
Copy Markdown
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

This comment was marked as outdated.

@samsrabin

samsrabin commented Jun 9, 2025

Copy link
Copy Markdown
Member

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

@ekluzek ekluzek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should pare this down, so it's mostly just the include of the README.md file. That way we just update most of the instructions in one place rather than both. The parts at the top can be the more abstract kind of things that aren't likely to change. So probably just some of the introductory parts at the top would be kept.

We should also think about if we need any figures to illustrate any of the process. I think that was important for mksurfdata_esmf, but may not be as important here. Although I also think some of those prior figures could be adapted to illustrate how mksurfdata_esmf works.

slevis resolved conflicts:
doc/source/users_guide/using-clm-tools/what-are-the-clm-tools.rst
slevis resolved conflicts:
doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst
@slevis-lmwg
slevis-lmwg marked this pull request as ready for review March 23, 2026 23:41
Comment thread doc/source/users_guide/using-clm-tools/creating-domain-files.rst Outdated
@slevis-lmwg slevis-lmwg moved this from In Progress to In review in CLM documentation Mar 24, 2026
@github-project-automation github-project-automation Bot moved this to Ready to start (or start again) in CTSM: Upcoming tags Mar 24, 2026
@github-project-automation github-project-automation Bot moved this from Ready to start (or start again) to Stalled (needs review, blocked etc.) in CTSM: Upcoming tags Mar 24, 2026
@slevis-lmwg slevis-lmwg moved this from Stalled (needs review, blocked etc.) to In progress - b4b-dev in CTSM: Upcoming tags Mar 24, 2026
@slevis-lmwg slevis-lmwg added this to the ctsm6.0.0 (code freeze) milestone Apr 15, 2026
Comment thread doc/source/lilac/obtaining-building-and-running/setting-ctsm-runtime-options.rst Outdated
@slevis-lmwg slevis-lmwg moved this from Stalled to In Progress in LMWG: Sprint Planning Board Apr 15, 2026
Comment thread doc/source/users_guide/using-clm-tools/creating-surface-datasets.rst Outdated
Comment thread tools/mksurfdata_esmf/README.md Outdated
Comment thread tools/mksurfdata_esmf/README.md

@ekluzek ekluzek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@slevis-lmwg and I just went over the changes. We have several things to do, but we don't feel like it needs a re-review afterwards. So approving, and he'll make the changes and bring in when ready.

@github-project-automation github-project-automation Bot moved this from In progress - b4b-dev to In progress - master in CTSM: Upcoming tags May 8, 2026
@slevis-lmwg
slevis-lmwg merged commit dd76b2e into ESCOMP:b4b-dev May 8, 2026
9 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in LMWG: Sprint Planning Board May 8, 2026
@github-project-automation github-project-automation Bot moved this from In progress - master to Done (non release/external) in CTSM: Upcoming tags May 8, 2026
@github-project-automation github-project-automation Bot moved this from In review to Done in CLM documentation May 8, 2026
@wwieder

wwieder commented May 13, 2026

Copy link
Copy Markdown
Contributor

@slevis-lmwg should the linked issues on this PR me manually closed?

@slevis-lmwg

Copy link
Copy Markdown
Contributor Author

@slevis-lmwg should the linked issues on this PR me manually closed?

I labeled both issues "done" which helps a little, otherwise typically these get closed with the next merge of b4b-dev to master.

@wwieder

wwieder commented May 13, 2026

Copy link
Copy Markdown
Contributor

Sorry for the confusion here, I didn't realize these were waiting for b4b-dev to come to master, I just saw the merged icon and assumed they were already there. Marking done for the purposes of the project board seems like a good way to track these?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b 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

Status: Done
Status: Done (non release/external)
Status: Done

Development

Successfully merging this pull request may close these issues.

Update and delete outdated docs for creating input data User's Guide: How to use the new mksurfdata_esmf tool

4 participants