Skip to content

Commit

Permalink
Update plumber_site.py script documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing authored Aug 16, 2024
1 parent b95b66a commit 82aeb6a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions python/ctsm/site_and_regional/plumber_site.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def run_case(
file path of base case
run_type: str, opt
transient, post_ad, or ad case, default ad
prism: bool, opt # TODO: remove?
prism: bool, opt (ad case is default because PLUMBER requires spinup)
if True, use PRISM precipitation, default False
user_version: str, opt # TODO: is there an equivalent for PLUMBER?
default 'latest'
Expand Down Expand Up @@ -115,7 +115,10 @@ def set_ref_case(self, case):
return True ### Check if super returns false, if this will still return True?

def modify_user_nl(self, case_root, run_type, rundir, site_lines=None):
# TODO: include any plumber-specific user namelist lines, using this as just an example currently
"""
This function can be used to include any plumber-specific user namelist lines
"""
# This is just an example currently. TODO: remove?
if site_lines is None:
site_lines = [
"""hist_fincl1 = 'TOTECOSYSC', 'TOTECOSYSN', 'TOTSOMC', 'TOTSOMN', 'TOTVEGC',
Expand Down

0 comments on commit 82aeb6a

Please sign in to comment.