Skip to content

Documentation of new features needed #2113

Closed
Closed

Description

@wwieder

We have a number of new features that have been added to the model recently that should be documented in the tech note and user's guide. I've started a short list of these and tried to suggest people who can help with this. Maybe at an upcoming meeting we can discuss how to efficiently get these contributions into our documentation?

And more that are moving through the queue like:

I'm sure there are others we need to add to this list...

Activity

  1. added
    documentationadditions or edits to user-facing documentation or its infrastructure
    nextthis should get some attention in the next week or two. Normally each Thursday SE meeting.
    on Aug 18, 2023
  2. self-assigned this
    on Aug 18, 2023
  3. mvdebolskiy commented on Aug 18, 2023

    @mvdebolskiy
    Contributor

    @wwieder Tech note documentation writeup was included in the #1787. See the Snow and Soil Temperatures section at master. If you want a user-guide write-up for the feature, i can make a quick PR with that.

  4. samsrabin commented on Aug 18, 2023

    @samsrabin
    Member

    Agreed. Should my things go under "Running with special cases," then?

  5. wwieder commented on Aug 18, 2023

    @wwieder
    ContributorAuthor

    Thanks @mvdebolskiy, that's excellent! do we just have to 'build' the tech note again for these to changes to show up on the wiki? Is there additional, practical information that should be included in the user's guide for excess ice? I'm not familiar with how to run with this feature?

    @samsrabin I'm not sure if the crop calendar work belongs with other crop model documentation or under [special cases in the user's guide]? Are the crop calendars not going to be on by default for CTSM5.1 crop simulations?

  6. samsrabin commented on Aug 18, 2023

    @samsrabin
    Member

    That's right, @wwieder. All I've done so far is add prescribed static crop calendars, which of course don't allow prognostic seasonal shifts. So "special cases" is probably more appropriate.

  7. mvdebolskiy commented on Aug 18, 2023

    @mvdebolskiy
    Contributor

    Thanks @mvdebolskiy, that's excellent! do we just have to 'build' the tech note again for these to changes to show up on the wiki?

    Yes.

    Is there additional, practical information that should be included in the user's guide for excess ice? I'm not familiar with how to run with this feature?

    Might be. I can add an entry to the "Run with special cases" about how initialization works and additional spinup required. However, it's described in the papers linked in the tech note.

  8. cenlinhe commented on Aug 18, 2023

    @cenlinhe
    Contributor

    @wwieder I am happy to contribute to the documentation for the SNICAR updates. Please let me know how I should proceed (e.g., prepare a word doc and send it to the CTSM team?) and when you will need it. Thanks!

  9. TeaganKing commented on Aug 18, 2023

    @TeaganKing
    Contributor

    @wwieder Do we want to add a new tech note section (eg, 2.33) for running with NEON? I'm not sure that it would fit under other pre-existing sections. I'd be happy to put something together for run_neon in general, as well as including some PRISM details, and make a PR to update the tech note.

    Can you clarify where in the user's guide you would want this?

  10. dlawrenncar commented on Aug 18, 2023

    @dlawrenncar
    Contributor
  11. samsrabin commented on Aug 18, 2023

    @samsrabin
    Member

    Definitely agree, @dlawrenncar. I'll send you et al. an email. For now, I have some ideas for "easy [prognostic] wins" in issue #1928.

  12. dmleung commented on Aug 18, 2023

    @dmleung
    Contributor

    Hi, I can write the dust updates for the tech note too!

  13. mvdebolskiy commented on Aug 21, 2023

    @mvdebolskiy
    Contributor

    @wwieder Are you making a PR I can contribute to, or should I just make a separate one?

  14. wwieder commented on Aug 21, 2023

    @wwieder
    ContributorAuthor

    You can make a new one, @mvdebolskiy. thanks.

  15. 43 remaining items

  16. samsrabin commented on May 29, 2025

    @samsrabin
    Member

    Closing, as such needs should now be their own issues with a docs: label.

  17. moved this from On the grill (work in progress) to Ready to eat (Done!) in CTSM-CLM6 development highlightson May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationadditions or edits to user-facing documentation or its infrastructure

Type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions