Skip to content

Conversation

@ijaguirre
Copy link

@ijaguirre ijaguirre commented Jul 6, 2025

Description of changes

More documentation for the PLUMBER 2 option using the newly developed ./run_tower tool created by @TeaganKing

Specific notes

Contributors other than yourself, if any:

CTSM Issues Fixed (include github issue #):
Related to #2997

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

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

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

Testing performed, if any: None

@TeaganKing TeaganKing self-requested a review July 7, 2025 03:53
Copy link
Contributor

@TeaganKing TeaganKing left a comment

Choose a reason for hiding this comment

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

Thanks so much for putting this together, @ijaguirre !

I have a few clarifying questions for you, and am happy to address the other changes myself if they seem reasonable to you! If you could just answer a few of the questions and thumbs up the comments if you agree with them, or of course share other thoughts, I'm happy to wrap this up!

Currently, the ``run_tower`` tool supports running CTSM at PLUMBER 2 sites using forcing data from the PLUMBER2 projects. Detailed site information is provided in `Ukkola et al. 2022 <https://doi.org/10.5194/essd-14-449-2022>`_ , and the description of the experiment and its results is provided in `Abramowitz et al. 2024 <https://doi.org/10.5194/bg-21-5517-2024>`_.
Information on the specific sites can be found `here <https://researchdata.edu.au/plumber2-forcing-evaluation-surface-models/1656048>`_.

Currently supported PLUMBER Sites can be found by running ``run_tower --help``. Keep in mind that the experiment was designed to run 170 sites; however, they identified different issues with the sites, and most of the article only uses 156 sites.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for including this information and the citations!

A few notes regarding the PLUMBER 2 simulations using the ``run_tower`` tool:


1) By default, all simulations (e.g., ad, post-ad, transient) are designed to run for 1 hour of wall clock time. For the spin-up simulations, it is recommended to extend the time to match the length of the simulations.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we make just one recommended spin-up configurations section? Eg, this could look like the section below & replace 1 and 2.

Recommended spin-up configurations

  • By default, all simulations (e.g., ad, post-ad, transient) are designed to run for 1 hour of wall clock time. For the spin-up simulations, we recommend extending the time to match the length of the simulations.
  • By default, the initial period of the simulations differs for the spin-up (e.g., ad and post-ad) and transient simulations. It is important to revisit for each site the best period to use for the spin-up simulations.
  • Additionally, we recommend spinning up with the no_leap calendar to avoid issues with Feb 28th and 29th on leap years.
  • Lastly, we recommend setting dtlimit=50 in the spin-up simulation of the user_nl_datm_strems files.


1) By default, all simulations (e.g., ad, post-ad, transient) are designed to run for 1 hour of wall clock time. For the spin-up simulations, it is recommended to extend the time to match the length of the simulations.
2) By default, the initial period of the simulations differs for the spin-up (e.g., ad and post-ad) and transient simulations. It is important to revisit for each site the best period to use for the spin-up simulations. It is suggested to run the spin-up simulations using the no_leap calendar to avoid issues with Feb 28/29 on leap years. It is also recommended to set a dtlimit value of 50 in the spin-up simulation of the user_nl_datm_strems files.
3) By default, the tools call for surfdata files in a default location. These might not be available for all sites. Users can create their own surfdata files, using tools/site_and_regional/plumber2_usermods.
Copy link
Contributor

Choose a reason for hiding this comment

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

tools/site_and_regional/plumber2_usermods and other files should be formatted to look like code

1) By default, all simulations (e.g., ad, post-ad, transient) are designed to run for 1 hour of wall clock time. For the spin-up simulations, it is recommended to extend the time to match the length of the simulations.
2) By default, the initial period of the simulations differs for the spin-up (e.g., ad and post-ad) and transient simulations. It is important to revisit for each site the best period to use for the spin-up simulations. It is suggested to run the spin-up simulations using the no_leap calendar to avoid issues with Feb 28/29 on leap years. It is also recommended to set a dtlimit value of 50 in the spin-up simulation of the user_nl_datm_strems files.
3) By default, the tools call for surfdata files in a default location. These might not be available for all sites. Users can create their own surfdata files, using tools/site_and_regional/plumber2_usermods.
4) It is suggested to use the flags-- setup-only to examine how the site files are being configured before running the simulations.
Copy link
Contributor

Choose a reason for hiding this comment

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

fix flag dashes

3) By default, the tools call for surfdata files in a default location. These might not be available for all sites. Users can create their own surfdata files, using tools/site_and_regional/plumber2_usermods.
4) It is suggested to use the flags-- setup-only to examine how the site files are being configured before running the simulations.
5) It is suggested to add ``echo "baseflow_scalar = 0" >> user_nl_clm`` to the user_nl_clm file to avoid issues with the baseflow in the wetland sites.
6) Currently, the tool is designed only for cases with active biochemistry. For SP simulations, it is recommended to use the user mods directory ``/CTSM/cime_config/usermods_dirs/clm/PLUMBER2/${site}``, which contains the necessary modifications to run the simulations in SP mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean to specify a different directory here? I think this is the default directory?

2) By default, the initial period of the simulations differs for the spin-up (e.g., ad and post-ad) and transient simulations. It is important to revisit for each site the best period to use for the spin-up simulations. It is suggested to run the spin-up simulations using the no_leap calendar to avoid issues with Feb 28/29 on leap years. It is also recommended to set a dtlimit value of 50 in the spin-up simulation of the user_nl_datm_strems files.
3) By default, the tools call for surfdata files in a default location. These might not be available for all sites. Users can create their own surfdata files, using tools/site_and_regional/plumber2_usermods.
4) It is suggested to use the flags-- setup-only to examine how the site files are being configured before running the simulations.
5) It is suggested to add ``echo "baseflow_scalar = 0" >> user_nl_clm`` to the user_nl_clm file to avoid issues with the baseflow in the wetland sites.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you clarify what 'issues' means here and in 2?

@ekluzek ekluzek added the documentation additions or edits to user-facing documentation or its infrastructure label Jul 7, 2025
@ekluzek
Copy link
Collaborator

ekluzek commented Jul 7, 2025

I'm rebasing the PR to come to b4b-dev. We may also need to rebase the branch itself, depending on where it's at.

@ekluzek ekluzek changed the base branch from master to b4b-dev July 7, 2025 17:13
@ekluzek ekluzek added next this should get some attention in the next week or two. Normally each Thursday SE meeting. test: docs Test documentation build before merging docs-loc:users-guide Relates to User's Guide (using CTSM/tools) labels Jul 7, 2025
@TeaganKing
Copy link
Contributor

I'm rebasing the PR to come to b4b-dev. We may also need to rebase the branch itself, depending on where it's at.

Thanks @ekluzek ! I think that the branch itself should be fine, at least with regards to this documentation file. I don't think the file has been otherwise updated recently.

@samsrabin samsrabin self-assigned this Jul 10, 2025
@ekluzek ekluzek removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-loc:users-guide Relates to User's Guide (using CTSM/tools) documentation additions or edits to user-facing documentation or its infrastructure test: docs Test documentation build before merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants