pywfm.misc.IWFMMiscellaneous.is_date_greater#

IWFMMiscellaneous.is_date_greater(first_date, comparison_date)#

returns True if first_date is greater than comparison_date

Parameters:

first_date (str) – IWFM date format MM/DD/YYYY_HH:MM
comparison_date (str) – IWFM date format MM/DD/YYYY_HH:MM

Returns:

True if first_date is greater (in the future) when compared to the comparison_date False if first_date is less (in the past) when compared to the comparison_date

Return type:

boolean

See also

IWFMModel.get_current_date_and_time: returns the current simulation date and time
IWFMModel.get_n_time_steps: returns the number of timesteps in an IWFM simulation
IWFMModel.get_time_specs: returns the IWFM simulation dates and time step
IWFMModel.get_n_intervals: returns the number of time intervals between a provided start date and end date
IWFMModel.get_output_interval: returns a list of the possible time intervals a selected time-series data can be retrieved at.
IWFMModel.increment_time: increments the date provided by the specified time interval

Examples

>>> from pywfm import IWFMModel
>>> dll = '../../DLL/Bin/IWFM2015_C_x64.dll'
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(dll, preprocessor_infile, simulation_infile)
>>> model.is_date_greater('09/30/2011_24:00', '10/01/2011_24:00')
False
>>> model.kill()

>>> from pywfm import IWFMModel
>>> dll = '../../DLL/Bin/IWFM2015_C_x64.dll'
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(dll, preprocessor_infile, simulation_infile)
>>> model.is_date_greater('03/28/2001_24:00', '06/30/1989_24:00')
True
>>> model.kill()