Fix time-series scripts use time bounds properly

mpas_analysis/ocean/ohc_timeseries.py

@@ -11,12 +11,14 @@
 
 from ..shared.io import NameList, StreamsFile
 
+from ..shared.timekeeping.Date import Date
+
 def ohc_timeseries(config):
     """
     Performs analysis of ocean heat content (OHC) from time-series output.
 
     Author: Xylar Asay-Davis, Milena Veneziani
-    Last Modified: 11/25/2016
+    Last Modified: 11/28/2016
     """
 
     # read parameters from config file
@@ -50,8 +52,6 @@ def ohc_timeseries(config):
     plots_dir = config.get('paths','plots_dir')
 
     yr_offset = config.getint('time','yr_offset')
-    timeseries_yr1 = yr_offset + config.getint('time', 'timeseries_yr1')
-    timeseries_yr2 = yr_offset + config.getint('time', 'timeseries_yr2')
 
     N_movavg = config.getint('ohc_timeseries','N_movavg')
 
@@ -90,14 +90,17 @@ def ohc_timeseries(config):
 
     ds = remove_repeated_time_index(ds)
 
+    # convert the start and end dates to datetime objects using
+    # the Date class, which ensures the results are within the
+    # supported range
+    time_start = Date(startDate).to_datetime(yr_offset)
+    time_end = Date(endDate).to_datetime(yr_offset)
     # select only the data in the specified range of years
-    # time_start = datetime.datetime(timeseries_yr1, 1, 1)
-    # time_end = datetime.datetime(timeseries_yr2, 12, 31)
-    # ds = ds.sel(Time=slice(time_start, time_end))
+    ds = ds.sel(Time=slice(time_start, time_end))
 
     # Select year-1 data and average it (for later computing anomalies)
-    time_start = datetime.datetime(timeseries_yr1, 1, 1)
-    time_end = datetime.datetime(timeseries_yr1, 12, 31)
+    time_start = datetime.datetime(time_start.year, 1, 1)
+    time_end = datetime.datetime(time_start.year, 12, 31)
     ds_yr1 = ds.sel(Time=slice(time_start,time_end))
     mean_yr1 = ds_yr1.mean('Time')
 

mpas_analysis/ocean/sst_timeseries.py

@@ -9,13 +9,15 @@
 
 from ..shared.io import StreamsFile
 
+from ..shared.timekeeping.Date import Date
+
 def sst_timeseries(config):
     """
     Performs analysis of the time-series output of sea-surface temperature
     (SST).
 
     Author: Xylar Asay-Davis, Milena Veneziani
-    Last Modified: 10/27/2016
+    Last Modified: 11/28/2016
     """
     # Define/read in general variables
     print "  Load SST data..."
@@ -55,6 +57,14 @@ def sst_timeseries(config):
                                            onlyvars=['time_avg_avgValueWithinOceanRegion_avgSurfaceTemperature']))
     ds = remove_repeated_time_index(ds)
 
+    # convert the start and end dates to datetime objects using
+    # the Date class, which ensures the results are within the
+    # supported range
+    time_start = Date(startDate).to_datetime(yr_offset)
+    time_end = Date(endDate).to_datetime(yr_offset)
+    # select only the data in the specified range of years
+    ds = ds.sel(Time=slice(time_start, time_end))
+
     SSTregions = ds.time_avg_avgValueWithinOceanRegion_avgSurfaceTemperature
 
     year_start = (pd.to_datetime(ds.Time.min().values)).year

mpas_analysis/sea_ice/timeseries.py

@@ -11,12 +11,14 @@
 from ..shared.io import StreamsFile
 from ..shared.io.utility import paths
 
+from ..shared.timekeeping.Date import Date
+
 def seaice_timeseries(config):
     """
     Performs analysis of time series of sea-ice properties.
 
     Author: Xylar Asay-Davis, Milena Veneziani
-    Last Modified: 10/27/2016
+    Last Modified: 11/28/2016
     """
 
     # read parameters from config file
@@ -79,6 +81,14 @@ def seaice_timeseries(config):
                                                      'timeSeriesStatsMonthly_avg_iceVolumeCell_1']))
     ds = remove_repeated_time_index(ds)
 
+    # convert the start and end dates to datetime objects using
+    # the Date class, which ensures the results are within the
+    # supported range
+    time_start = Date(startDate).to_datetime(yr_offset)
+    time_end = Date(endDate).to_datetime(yr_offset)
+    # select only the data in the specified range of years
+    ds = ds.sel(Time=slice(time_start, time_end))
+
     ds = ds.merge(dsmesh)
 
     year_start = (pd.to_datetime(ds.Time.min().values)).year

mpas_analysis/shared/timekeeping/Date.py

@@ -7,6 +7,7 @@
 
 import functools
 import numpy
+import datetime
 
 @functools.total_ordering
 class Date(object):
@@ -75,6 +76,50 @@ def __init__(self, dateString=None, isInterval=False, totalSeconds=None,
             self.seconds = numpy.int64(seconds)
             self._setTotalSeconds()
 
+    def to_datetime(self, yearOffset=0):
+        """
+        Converts the date object to a datetime object.
+        The yearOffset is added to this date's year, and
+        the resulting date is clamped to the range supported by
+        numpy's datetime64[ns], used internally by xarray an
+        pandas
+
+        Last modified: 11/28/2016
+        Author: Xylar Asay-Davis
+        """
+        if self.isInterval:
+            raise ValueError("self.isInterval == True. Use to_timedelta "
+                             "instead of to_datetime")
+
+        year = numpy.maximum(datetime.MINYEAR,
+                             numpy.minimum(datetime.MAXYEAR,
+                                           self.years+yearOffset))
+        outDate =  datetime.datetime(year=year, month=self.months+1,
+                                     day=self.days+1, hour=self.hours,
+                                     minute=self.minutes, second=self.seconds)
+
+        minDate = datetime.datetime(year=1678, month=1, day=1,
+                                    hour=0, minute=0, second=0)
+        maxDate = datetime.datetime(year=2262, month=1, day=1,
+                                    hour=0, minute=0, second=0)
+        outDate = max(minDate, min(maxDate, outDate))
+        return outDate
+
+    def to_timedelta(self):
+        """
+        Converts the date object to a timedelta object
+
+        Last modified: 11/28/2016
+        Author: Xylar Asay-Davis
+        """
+        if not self.isInterval:
+            raise ValueError("self.isInterval == False. Use to_datetime "
+                             "instead of to_timedelta")
+
+        days = 365*self.years + self._monthsToDays(self.months) + self.days
+        return datetime.timedelta(days=self.days, hours=self.hours,
+                                  minutes=self.minutes, seconds=self.seconds)
+
     def __lt__(self, other):
         if self.isInterval != other.isInterval:
             raise ValueError('Comparing interval with non-interval Date '
@@ -130,24 +175,22 @@ def __sub__(self, other):
         return Date(isInterval=isInterval, years=years, months=months,
                     days=days, hours=hours, minutes=minutes, seconds=seconds)
 
-
     def __str__(self):
         if self.isInterval:
             offset = 0
         else:
             offset = 1
-        return '{:04d}-{:02d}-{:02d} {:02d}:{:02d}:{:02d}' \
-                    .format(self.years, self.months+offset, self.days+offset,
-                            self.hours, self.minutes, self.seconds)
+        return '{:04d}-{:02d}-{:02d} {:02d}:{:02d}:{:02d}'.format(
+            self.years, self.months+offset, self.days+offset,
+            self.hours, self.minutes, self.seconds)
 
     def _diffSeconds(self, other):
         return
 
     def _setTotalSeconds(self):
         days = self.years*365 + self._monthsToDays(self.months) + self.days
-        self.totalSeconds = (((days*24 + self.hours)*60 + self.minutes)*60
-                             + self.seconds)
-
+        self.totalSeconds = (((days*24 + self.hours)*60 + self.minutes)*60 +
+                             self.seconds)
 
     def _monthsToDays(self, months):
         daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
@@ -182,7 +225,7 @@ def _secondsToDate(self, seconds):
     def _parseDate(self, dateString):
         """
         parses a dateString in one of the following formats into
-        a datetime object:
+        a Date object:
         YYYY-MM-DD_hh:mm:ss
         YYYY-MM-DD_hh.mm.ss
         YYYY-MM-DD_SSSSS
@@ -213,7 +256,7 @@ def _parseDate(self, dateString):
                 hms = dateString
 
         if '.' in hms:
-            hms = hms.replace('.',':')
+            hms = hms.replace('.', ':')
 
         if '-' in ymd:
             (self.years, self.months, self.days) \

mpas_analysis/test/test_date.py

@@ -6,6 +6,7 @@
 """
 
 import pytest
+import datetime
 from mpas_analysis.test import TestCase, loaddatadir
 from mpas_analysis.shared.timekeeping.Date import Date
 
@@ -118,5 +119,37 @@ def test_date(self):
         diff = date1-date2
         self.assertEqual(diff, Date(dateString='1995-12-26', isInterval=False))
 
+        date = Date(dateString='1996-01-15', isInterval=False)
+        datetime1 = date.to_datetime(yearOffset=0)
+        datetime2 = datetime.datetime(year=1996, month=1, day=15)
+        self.assertEqual(datetime1, datetime2)
+
+        date = Date(dateString='0000-00-20', isInterval=True)
+        timedelta1 = date.to_timedelta()
+        timedelta2 = datetime.timedelta(days=20)
+        self.assertEqual(timedelta1, timedelta2)
+
+        # since pandas and xarray use the numpy type 'datetime[ns]`, which
+        # has a limited range of dates, the date 0001-01-01 gets increased to
+        # the minimum allowed year boundary, 1678-01-01 to avoid invalid
+        # dates.
+        date = Date(dateString='0001-01-01', isInterval=False)
+        datetime1 = date.to_datetime(yearOffset=0)
+        datetime2 = datetime.datetime(year=1678, month=1, day=1)
+        self.assertEqual(datetime1, datetime2)
+
+        date = Date(dateString='0001-01-01', isInterval=False)
+        datetime1 = date.to_datetime(yearOffset=1849)
+        datetime2 = datetime.datetime(year=1850, month=1, day=1)
+        self.assertEqual(datetime1, datetime2)
+
+        # since pandas and xarray use the numpy type 'datetime[ns]`, which
+        # has a limited range of dates, the date 9999-01-01 gets decreased to
+        # the maximum allowed year boundary, 2262-01-01 to avoid invalid
+        # dates.
+        date = Date(dateString='9999-01-01', isInterval=False)
+        datetime1 = date.to_datetime(yearOffset=0)
+        datetime2 = datetime.datetime(year=2262, month=1, day=1)
+        self.assertEqual(datetime1, datetime2)
 
 # vim: foldmethod=marker ai ts=4 sts=4 et sw=4 ft=python