Skip to content

Update single point docs (and improve subset_data etc. erroring)#3002

Merged
samsrabin merged 24 commits intoESCOMP:b4b-devfrom
samsrabin:single-point-docs-202503
Mar 27, 2025
Merged

Update single point docs (and improve subset_data etc. erroring)#3002
samsrabin merged 24 commits intoESCOMP:b4b-devfrom
samsrabin:single-point-docs-202503

Conversation

@samsrabin
Copy link
Copy Markdown
Member

@samsrabin samsrabin commented Mar 11, 2025

Description of changes

  • Updates single-point documentation to reflect the current workflow
  • Adds error messages in subset_data and related scripts to give descriptive error messages when the user tries something that isn't supported and/or is buggy

Corresponding ctsm-docs PR: ESCOMP/ctsm-docs#8

Remaining work:

Specific notes

Contributors other than yourself, if any: Katie Rocci, @adrifoster

CTSM Issues Fixed:

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:

As of 7c1d2dc:

  • Python unit tests
  • Python system tests

As of 685e08e (but nothing changed since then is tested in this suite):

  • clm_pymods test suite

As of 79e202d:

  • Python unit tests
  • Python system tests
  • Documentation build

@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure testing additions or changes to tests test: docs Test documentation build before merging labels Mar 11, 2025
@samsrabin samsrabin self-assigned this Mar 11, 2025
@samsrabin samsrabin changed the base branch from master to b4b-dev March 11, 2025 18:46
@ekluzek
Copy link
Copy Markdown
Contributor

ekluzek commented Mar 11, 2025

A short skim of this and I'm liking what I see. Thanks for starting work on this. The simple note you added about single point is a great starting point to have in place.

@samsrabin samsrabin marked this pull request as ready for review March 11, 2025 19:58
@samsrabin samsrabin requested a review from ekluzek March 11, 2025 19:58
@samsrabin samsrabin marked this pull request as ready for review March 12, 2025 03:38
@samsrabin samsrabin added the PR status: awaiting review Work on this PR is paused while waiting for review. label Mar 12, 2025
@samsrabin
Copy link
Copy Markdown
Member Author

@ekluzek Sorry for the many pings on this as it went ready/draft/ready, but it's really ready now. Could you please review today so I can merge it before b4b-dev is locked tomorrow?

Copy link
Copy Markdown
Contributor

@ekluzek ekluzek left a comment

Choose a reason for hiding this comment

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

The code is great here. I have a long discussion about what to do with the modify_fsurdat unit tests that had to change. I recommend changing it to delete that code, but I'll leave it up to you.

I have several suggestions on the documentation. The main of which I already brought up and we agreed to leave the PTS_MODE documentation, but don't highlight it.

I'm marking this as approve at this point so you can bring it in without tracking me down again for reapproval.

Comment thread doc/source/users_guide/overview/introduction.rst
Comment thread doc/source/users_guide/running-single-points/running-single-point-subset-data.rst Outdated
Comment thread doc/source/users_guide/running-single-points/index.rst
Comment thread doc/source/users_guide/running-single-points/running-single-point-subset-data.rst Outdated
Comment thread python/ctsm/test/test_unit_modify_fsurdat.py
@samsrabin
Copy link
Copy Markdown
Member Author

samsrabin commented Mar 13, 2025

@samsrabin samsrabin added the blocked: dependency Wait to work on this until dependency is resolved label Mar 13, 2025
Comment thread python/ctsm/subset_data.py
Comment thread doc/source/users_guide/running-single-points/running-single-point-subset-data.rst Outdated
@samsrabin samsrabin removed blocked: dependency Wait to work on this until dependency is resolved PR status: awaiting review Work on this PR is paused while waiting for review. labels Mar 17, 2025
@samsrabin samsrabin merged commit 002a0a6 into ESCOMP:b4b-dev Mar 27, 2025
2 checks passed
@github-project-automation github-project-automation Bot moved this from In progress - master/b4b-dev to Done (non release/external) in CTSM: Upcoming tags Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit documentation additions or edits to user-facing documentation or its infrastructure test: docs Test documentation build before merging testing additions or changes to tests

Projects

Status: Done (non release/external)

3 participants