def time_range(self, start=None, end=None, interval="1Y", extend_end=True):
(num, timeUnit) = TimeVector.parseTimeUnit(interval)
if start is None:
start = self.getDataStartTime()
else:
if isinstance(start, datetime.date):
start = datetime.datetime(start.year, start.month, start.day,
0, 0, 0)
if start < self.getDataStartTime():
start = self.getDataStartTime()
if end is None:
end = self.getEndTime()
else:
if isinstance(end, datetime.date):
end = datetime.datetime(end.year, end.month, end.day, 0, 0, 0)
if end > self.getEndTime():
end = self.getEndTime()
if end < start:
raise ValueError("Invalid time interval start after end")
range_start = start
range_end = end
if not timeUnit == "d":
year1 = start.year
year2 = end.year
month1 = start.month
month2 = end.month
day1 = start.day
day2 = end.day
if extend_end:
if timeUnit == 'm':
if day2 > 1:
month2 += 1
if month2 == 13:
year2 += 1
month2 = 1
elif timeUnit == "y":
month1 = 1
if year2 > 1 or day2 > 1:
year2 += 1
month2 = 1
day1 = 1
day2 = 1
range_start = datetime.date(year1, month1, day1)
range_end = datetime.date(year2, month2, day2)
trange = TimeVector.createRegular(range_start, range_end, interval)
# If the simulation does not start at the first of the month
# the start value will be before the simulation start; we
# manually shift the first element in the trange to the start
# value; the same for the end of list.
if trange[-1] < end:
if extend_end:
trange.appendTime(num, timeUnit)
else:
trange.append(end)
data_start = self.getDataStartTime()
if trange[0] < data_start:
trange[0] = CTime(data_start)
return trange
def time_range(self,
start=None,
end=None,
interval="1Y",
num_timestep=None,
extend_end=True):
"""Will create a vector of timepoints based on the current case.
By default the timepoints will be regularly sampled based on the
interval given by the @interval string. Alternatively the total number
of timesteps can be specified, if the @num_timestep option is specified
that will take presedence.
"""
(num, timeUnit) = TimeVector.parseTimeUnit(interval)
if start is None:
start = self.getDataStartTime()
else:
if isinstance(start, datetime.date):
start = datetime.datetime(start.year, start.month, start.day,
0, 0, 0)
if start < self.getDataStartTime():
start = self.getDataStartTime()
if end is None:
end = self.getEndTime()
else:
if isinstance(end, datetime.date):
end = datetime.datetime(end.year, end.month, end.day, 0, 0, 0)
if end > self.getEndTime():
end = self.getEndTime()
if end < start:
raise ValueError("Invalid time interval start after end")
if not num_timestep is None:
return TimeVector.create_linear(CTime(start), CTime(end),
num_timestep)
range_start = start
range_end = end
if not timeUnit == "d":
year1 = start.year
year2 = end.year
month1 = start.month
month2 = end.month
day1 = start.day
day2 = end.day
if extend_end:
if timeUnit == 'm':
if day2 > 1:
month2 += 1
if month2 == 13:
year2 += 1
month2 = 1
elif timeUnit == "y":
month1 = 1
if year2 > 1 or day2 > 1:
year2 += 1
month2 = 1
day1 = 1
day2 = 1
range_start = datetime.date(year1, month1, day1)
range_end = datetime.date(year2, month2, day2)
trange = TimeVector.createRegular(range_start, range_end, interval)
# If the simulation does not start at the first of the month
# the start value will be before the simulation start; we
# manually shift the first element in the trange to the start
# value; the same for the end of list.
if trange[-1] < end:
if extend_end:
trange.appendTime(num, timeUnit)
else:
trange.append(end)
data_start = self.getDataStartTime()
if trange[0] < data_start:
trange[0] = CTime(data_start)
return trange