c3s_sm package

Submodules

c3s_sm.cli module

c3s_sm.const module

c3s_sm.const.check_api_read() → bool[source]

c3s_sm.download module

c3s_sm.interface module

Readers for the C3S soil moisture products daily, dekadal (10-daily) and monthly images as well as for timeseries generated using this module

class c3s_sm.interface.C3SImg(filename, parameters=None, mode='r', subgrid=<smecv_grid.grid.SMECV_Grid_v052 object>, flatten=False, fillval={'sm': nan, 'sm_uncertainty': nan, 't0': nan})[source]

Bases: ImageBase

Class to read a single C3S image (for one time stamp)

close(*args, **kwargs)[source]: Close file.

flush(*args, **kwargs)[source]: Flush data.

read(timestamp=None)[source]

Read a single C3S image, if it exists, otherwise fill an empty image.

Parameters:: timestamp (datetime, optional (default: None)) – Time stamp of the image, if this is passed, it is compared to the time stamp from the loaded file and must match

write(*args, **kwargs)[source]

Write data to an image file.

Parameters:: image (object) – pygeobase.object_base.Image object

class c3s_sm.interface.C3STs(ts_path, grid_path=None, remove_nans=False, drop_tz=True, **kwargs)[source]

Bases: GriddedNcOrthoMultiTs

Module for reading C3S time series in netcdf format.

iter_ts(**kwargs)[source]

read_cell(cell, var='sm') → DataFrame[source]

Read all time series for a single variable in the selected cell.

Parameters:

cell (int) – Cell number as in the c3s grid
var (str, optional (default: 'sm')) – Name of the variable to read.

write_ts(*args, **kwargs)[source]

class c3s_sm.interface.C3S_Nc_Img_Stack(data_path, parameters='sm', subgrid=<smecv_grid.grid.SMECV_Grid_v052 object>, flatten=False, solve_ambiguity='sort_last', fntempl='C3S-SOILMOISTURE-L3S-SSM{unit}-{product}-{freq}-{datetime}-{record}-{version}.{subversion}.nc', subpath_templ=('%Y', ), fillval=None)[source]

Bases: MultiTemporalImageBase

Class for reading multiple images and iterate over them.

read(timestamp, **kwargs)[source]

Return an image for a specific timestamp.

Parameters:: timestamp (datetime.datetime) – Time stamp.
Returns:: image – pygeobase.object_base.Image object
Return type:: object

tstamps_for_daterange(start_date, end_date)[source]

Return dates in the passed period, with respect to the temp resolution of the images in the path.

Parameters:

start_date (datetime) – start of date range
end_date (datetime) – end of date range

Returns:

timestamps – list of datetime objects of each available image between start_date and end_date

Return type:

Iterator

c3s_sm.metadata module

class c3s_sm.metadata.C3S_SM_TS_Attrs(sensor_type, version)[source]

Bases: object

Default, common metadata for daily and monthly, dekadal products

atts_sensor_type(sensor_type='active')[source]

dn_flag()[source]

flag()[source]

freqbandID_flag()[source]

mode_flag()[source]

sensor_flag()[source]

class c3s_sm.metadata.C3S_SM_TS_Attrs_v201706(sensor_type)[source]: Bases: C3S_SM_TS_Attrs

class c3s_sm.metadata.C3S_SM_TS_Attrs_v201801(sensor_type)[source]: Bases: C3S_SM_TS_Attrs

class c3s_sm.metadata.C3S_SM_TS_Attrs_v201812(sensor_type)[source]: Bases: C3S_SM_TS_Attrs

class c3s_sm.metadata.C3S_SM_TS_Attrs_v201912(sensor_type)[source]: Bases: C3S_SM_TS_Attrs

class c3s_sm.metadata.C3S_SM_TS_Attrs_v202012(sensor_type)[source]

Bases: C3S_SM_TS_Attrs

sensor_flag()[source]

class c3s_sm.metadata.C3S_SM_TS_Attrs_v202212(sensor_type)[source]

Bases: C3S_SM_TS_Attrs

flag()[source]

sensor_flag()[source]

class c3s_sm.metadata.C3S_SM_TS_Attrs_v202312(sensor_type)[source]: Bases: C3S_SM_TS_Attrs

class c3s_sm.metadata.C3S_daily_tsatt_nc(cdr_type: str, sensor_type: str, cls)[source]: Bases: object

class c3s_sm.metadata.C3S_dekmon_tsatt_nc(freq: str, cdr_type: str, sensor_type: str, cls)[source]

Bases: object

Attributes for c3s dekadal and monthly for active, passive and combined tcdr and icdr timeseries files.