seims.preprocess.hydro_climate_data_itp Namespace Reference

Functions
def	interpolate_observed_data_to_regular_interval (in_file, time_interval, start_time, end_time, eliminate_zero=False, time_sys_output='UTCTIME', day_divided_hour=0)
def	main ()

Detailed Description

Interpolate hydro-climate data from not regular observed data to desired time interval.

This script is not intended to be integrated into SEIMS preprocess workflow.
   This function can be integrated into HydroClimateUtilClass in the future.

    @author   : Liangjun Zhu

    @changelog:
    - 17-07-25  - lj - initial implementation
    - 18-02-08  - lj - compatible with Python3.

Function Documentation

interpolate_observed_data_to_regular_interval()

def seims.preprocess.hydro_climate_data_itp.interpolate_observed_data_to_regular_interval	(		in_file,
			time_interval,
			start_time,
			end_time,
			eliminate_zero = False,
			time_sys_output = 'UTCTIME',
			day_divided_hour = 0
	)

Interpolate not regular observed data to regular time interval data.

Todo: Not tested yet!

Args:
    in_file: input data file, the basic format is as follows:
             line 1: #<time_system> [<time_zone>], e.g., #LOCALTIME 8, #UTCTIME
             line 2: DATETIME,field1,field2,...
             line 3: YYYY-mm-dd HH:MM:SS,field1_value,field2_value,...
             line 4: ...
             ...
             Field name can be PCP, FLOW, SED
             the unit is mm/h, m3/s, g/L (i.e., kg/m3), respectively.
    time_interval: time interval, unit is minute, e.g., daily output is 1440
    start_time: start time, the format must be 'YYYY-mm-dd HH:MM:SS', and the time system
                is based on time_sys.
    end_time: end time, see also start_time.
    eliminate_zero: Boolean flag. If true, the time interval without original records will
                    not be output.
    time_sys_output: time system of output time_system, the format must be
              '<time_system> [<time_zone>]', e.g.,
              'LOCALTIME'
              'LOCALTIME 8'
              'UTCTIME' (default)
    day_divided_hour: If the time_interval is equal to N*1440, this parameter should be
                      carefully specified. The value must range from 0 to 23. e.g.,
                      day_divided_hour ==> day ranges (all expressed as 2013-02-03)
                      0  ==> 2013-02-03 00:00:00 to 2013-02-03 23:59:59 (default)
                      8  ==> 2013-02-03 08:00:00 to 2013-02-04 07:59:59
                      20 ==> 2013-02-03 20:00:00 to 2013-02-04 19:59:59
Returns:
    The output data files are located in the same directory with the input file.
    The nomenclature is: <field name>_<time system>_<time interval>_<nonzero>, e.g.,
    pcp_utctime_1440_nonzero.csv, flow_localtime_60.csv.
    Note that `.txt` format is also supported.

main()

def seims.preprocess.hydro_climate_data_itp.main

(

)

TEST CODE