Allow adding a day to streams' file name date specifier #224
Conversation
This is needed for the new presaero 24-hour cplhist files, where the first file name has a date stamp of 0001-01-02.
These can be run with a command like this: PYTHONPATH=$PYTHONPATH:../../../cime/CIME/Tools python -m doctest stream_cdeps.py
|
I thought about adding a consistency check that throws an error if you try to specify the new attribute on a file name that does not have the |
| @@ -427,7 +434,33 @@ def _days_in_month(month, year=1): | |||
| next_month_start = datetime.date(next_year, next_month, 1) | |||
| return (next_month_start - month_start).days | |||
|
|
|||
| def _sub_paths(self, filenames, year_start, year_end): | |||
| @classmethod | |||
| def _add_day(cls, year, month, day): | |||
There was a problem hiding this comment.
A couple of notes about this function:
(1) I considered using python's datetime module to do the addition of a day, but it seems like this would assume the use of a Gregorian (leap year) calendar, which we don't want here. Working around that felt like it would be at least as complicated as just writing our own function.
(2) In principle this could be extended to add N days instead of just one. But I'm having trouble envisioning a scenario where we'd want to add more than one day, so for now decided to keep it simple, following the YAGNI (You Aren't Gonna Need It) principle. We can always extend it later.
| >>> StreamCDEPS._add_day(1999, 1, 1) | ||
| (1999, 1, 2) | ||
| >>> StreamCDEPS._add_day(1999, 1, 31) | ||
| (1999, 2, 1) | ||
| >>> StreamCDEPS._add_day(1999, 12, 31) | ||
| (2000, 1, 1) |
There was a problem hiding this comment.
The doctests here can be run manually with:
PYTHONPATH=$PYTHONPATH:../../../cime/CIME/Tools python -m doctest stream_cdeps.py
There was a problem hiding this comment.
I see that you have used xml_element here. I feel strongly that this method should not be used outside of the cime/CIME/XML directory - the idea is that if we confine it's use to that directory and only use higher level methods outside then changing the underlying format only will be straight forward. However I also see that this method has been used before in this file. I will approve this PR but I'm also going to open an issue requesting that this file be changed to remove these references to lowlevel interfaces.
|
Thanks, @jedwards4b . So are you okay if I go ahead and merge this despite the pre-existing issue so that @olyson can build off of it? |
|
@billsacks yes go ahead and merge |
Update stream definitions for new coupler history file format ### Description of changes Modify stream_definition_datm.xml to generate a streams file (datm.streams.xml) with the new coupler history file format. ### Specific notes Changes to accommodate new coupler history file names. Change offset for solar stream from 2700 to -900 to accommodate changes due to time stamps. These changes work in conjunction with CDEPS PR #224 and CDEPS PR #222 . Note that I did not change the file names for ndep, or remove that stream. See #230 Contributors other than yourself, if any: @billsacks CDEPS Issues Fixed (include github issue #): N/A Are there dependencies on other component PRs (if so list): No Are changes expected to change answers (bfb, different to roundoff, more substantial): Yes, in coupler history mode. Any User Interface Changes (namelist or namelist defaults changes): No Testing performed (e.g. aux_cdeps, CESM prealpha, etc): I have conducted a pair of cases, an F-case to generate coupler history files, and an I-case to read those files, using the new file name convention, and compared the forcing output variables from clm history files between the two cases. @billsacks and I reviewed these differences and found them to be acceptable. @billsacks ran SMS_D_Ld1.ne30pg3_t061.I1850Clm50BgcSpinup.cheyenne_intel.clm-cplhist in the context of ESCOMP/CTSM#1999 Hashes used for testing: N/A
Description of changes
This is needed for the new presaero 24-hour cplhist files, where the first file name has a date stamp of 0001-01-02.
This can be leveraged by changing the file specifier for a stream – such as the presaero stream – to have a filename_advance_days="1" attribute like this:
Specific notes
Contributors other than yourself, if any: @olyson
CDEPS Issues Fixed (include github issue #): none
Are there dependencies on other component PRs (if so list): No
Are changes expected to change answers (bfb, different to roundoff, more substantial): No
Any User Interface Changes (namelist or namelist defaults changes): None
Testing performed (e.g. aux_cdeps, CESM prealpha, etc): Manual testing
Hashes used for testing: CTSM at tag ctsm5.1.dev120, with its corresponding externals