Skip to content

New documentation for the CTSM dust emission module#3624

Open
dmleung wants to merge 8 commits intoESCOMP:b4b-devfrom
dmleung:docs-playground
Open

New documentation for the CTSM dust emission module#3624
dmleung wants to merge 8 commits intoESCOMP:b4b-devfrom
dmleung:docs-playground

Conversation

@dmleung
Copy link
Contributor

@dmleung dmleung commented Nov 24, 2025

… New CTSM dust emission documentation by @dmleung.

Description of changes

This PR is on updating the ctsm tech note / documentation on the CTSM dust emission modules, Leung_2023 and Zender_2003.

Specific notes

Contributors other than yourself, if any:
@samsrabin @ekluzek
@tilmes

CTSM Issues Fixed (include github issue #):
#3170

Are answers expected to change (and if so in what way)?
No, this is a documentation to the dust emission module

Any User Interface Changes (namelist or namelist defaults changes)?
No

Does this create a need to change or add documentation? Did you do so?
This PR is on changing the documentation.

Testing performed, if any:

@dmleung
Copy link
Contributor Author

dmleung commented Nov 24, 2025

Hi @samsrabin I do need to make a few more commits to clean up the doc, check section numbers, and add references before it's ready for review. I will make updates soon, but I do want to put a draft PR here. Thanks!

@ekluzek ekluzek changed the base branch from master to b4b-dev November 24, 2025 20:36
@ekluzek
Copy link
Collaborator

ekluzek commented Nov 24, 2025

I rebased this to come to b4b-dev rather than master.

@ekluzek
Copy link
Collaborator

ekluzek commented Nov 24, 2025

I rebased this to come in on b4b-dev rather than master.

@dmleung
Copy link
Contributor Author

dmleung commented Nov 25, 2025

Oh, I don't know we are merging to b4b-dev. Thanks for doing that Erik!

@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure docs:update Significant update or fix needed to existing documentation docs-loc:tech-note Relates to Technical Note (science) labels Nov 25, 2025
@samsrabin samsrabin linked an issue Nov 25, 2025 that may be closed by this pull request
8 tasks
@samsrabin samsrabin moved this to In Progress in CLM documentation Nov 25, 2025
@dmleung dmleung marked this pull request as ready for review January 12, 2026 20:27
@dmleung
Copy link
Contributor Author

dmleung commented Jan 12, 2026

Hi @samsrabin and @ekluzek, I just wanted to ping you and say that I think this PR is ready for review when you have time.
Let me know if there are issues and I can edit the files further. Thanks!

Copy link
Collaborator

@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.

@dmleung thanks for your work here! It's nice to have this update in place, and not to have to worry about getting it in later.

I have a couple suggestions about handling "g" and changing rho _{a} to rho _{atm} as that seems to be more consistent in other places in the tech note. We should also just remove the details about Zender, as that will be documented in the CLM50 tech note, and it would be confusing here. You might mention it as the previous method and say details on it are in the CLM50 tech note. But, it adds too much complexity to give the full details of both here.

@ekluzek ekluzek changed the title A new documentation for the CTSM dust emission module New documentation for the CTSM dust emission module Jan 15, 2026
@slevis-lmwg
Copy link
Contributor

@dmleung
I'm checking in because we are about to focus on documentation needs for the release.
Could you address Erik's review when you have a chance, so that we may merge this to b4b-dev?
Thanks,
Sam L.

@slevis-lmwg slevis-lmwg added the bfb bit-for-bit label Mar 16, 2026
@dmleung
Copy link
Contributor Author

dmleung commented Mar 17, 2026

@dmleung I'm checking in because we are about to focus on documentation needs for the release. Could you address Erik's review when you have a chance, so that we may merge this to b4b-dev? Thanks, Sam L.

Hi Sam, yes! Is it okay if I try to finish it by this weekend so you can work on it next week?

@slevis-lmwg
Copy link
Contributor

That sounds good. Thank you @dmleung!

…nstants for the dust doc. Removed description of Zender 2003 dust emission scheme in the doc.
@dmleung
Copy link
Contributor Author

dmleung commented Mar 23, 2026

@slevis-lmwg @ekluzek
I followed Erik's comments to make changes. Please see the latest commit. Let me know if you want me to make further changes!

Copy link
Contributor

@slevis-lmwg slevis-lmwg left a comment

Choose a reason for hiding this comment

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

Requesting a correction that I noticed, and maybe I can resolve it myself.

Copy link
Contributor

@slevis-lmwg slevis-lmwg left a comment

Choose a reason for hiding this comment

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

I'm ready to approve this PR.
@ekluzek you need to approve it, too, because you requested changes.
@dmleung thank you for all your work here!

@slevis-lmwg slevis-lmwg moved this from In Progress to In review in CLM documentation Mar 23, 2026
:label: 30.3

where :math:`T` is a global factor that compensates for the DEAD model's sensitivity to horizontal and temporal resolution and equals 5 x 10\ :sup:`-4` in the CLM instead of 7 x 10\ :sup:`-4` in :ref:`Zender et al. (2003)<Zenderetal2003>`. :math:`S` is the source erodibility factor set to 1 in the CLM and serves as a place holder at this time.
w=\theta\frac{ \rho _{water} }{\rho_{bulk} }
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
w=\theta\frac{ \rho _{water} }{\rho_{bulk} }
w=\theta\frac{ \rho _{liq} }{\rho_{bulk} }

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:tech-note Relates to Technical Note (science) documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

Docs needed: Dust updates

4 participants