cic package

cic.processor module

cic.processor.cic_processor(config_file)

Process CIC data

Parameters:

config_filestr

full path to configuration file

cic.processor.make_cic_config_template(file_name)

Make a configuration file template

Parameters:

file_namestr

full path to configuration file. For example /home/user/cic_config.yml

cic.utils module

cic.utils.combine_data(source_dir, date_range, time_reso, flag_sensitivity=0.5)

Combine netcdf datafiles and resample to new resolution on continuous time index

Parameters:

source_dirstr

Directory for CIC datafiles

date_rangepandas.DatetimeIndex

Range of dates for combining data

time_resostr

A pandas date frequency string. See for all options here: https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases

flag_sensitivityfloat

fraction of time flag needs to be present in resampling

Returns:

xarray.Dataset or None

Combined dataset, None if no data in the date range

cic.utils.remove_flagged_rows(ds, flag)

Set data associated with given flag as NaN

Parameters:

dsxarray.Dataset

CIC dataset

flagstr

Flag to be removed

Returns:

xarray.Dataset

CIC dataset with flag rows set to NaN