Skip to content

Commit 82aeb6a

Browse files
authored
Update plumber_site.py script documentation
1 parent b95b66a commit 82aeb6a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

python/ctsm/site_and_regional/plumber_site.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def run_case(
7777
file path of base case
7878
run_type: str, opt
7979
transient, post_ad, or ad case, default ad
80-
prism: bool, opt # TODO: remove?
80+
prism: bool, opt (ad case is default because PLUMBER requires spinup)
8181
if True, use PRISM precipitation, default False
8282
user_version: str, opt # TODO: is there an equivalent for PLUMBER?
8383
default 'latest'
@@ -115,7 +115,10 @@ def set_ref_case(self, case):
115115
return True ### Check if super returns false, if this will still return True?
116116

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

0 commit comments

Comments
 (0)