dsbuilder.dsbuilder module¶

Handling for multiple ds format specs

class dsbuilder.dsbuilder.DSBuilder(variables_defs=None, metadata_defs=None)¶

Bases: object

Class to generate xarray Datasets following various file format specification.

Parameters

variables_defs (Optional[Dict]) – variables_dict for each product format
metadata_defs (Optional[Dict]) – metadata for each product format

Each dictionary has as keys "ds_format" strings that define the names of the different available dataset formats, e.g. “Level-0”.

For variables_defs the corresponding entries should be a variable definition dictionary.

For metadata_defs the corresponding entries should be a dictionary of per product metadata.

create_ds_template(dim_sizes_dict, ds_format)¶

Returns template dataset

Parameters

dim_sizes_dict (Dict[str, int]) – entry per dataset dimension with value of size
ds_format (str) – product format string (value returned by self.return_ds_formats())

Return type

Dataset

Returns

Empty dataset

create_empty_dim_sizes_dict(ds_format)¶

Returns empty dim_size_dict for specified ds format

Parameters: ds_format (str) – product format string (value returned by self.return_ds_formats())
Return type: Dict[str, None]
Returns: empty dim_size_dict

return_ds_format_dim_names(ds_format)¶

Returns dims required for specified ds format

Parameters: ds_format (str) – product format string (value returned by self.return_ds_formats())
Return type: List[str]
Returns: ds format dims

return_ds_format_variable_dict(ds_format, variable_name)¶

Returns variable definition info for specified ds format

Parameters

ds_format (str) – product format string (value returned by self.return_ds_formats())
variable_name (str) – variable name

Return type

Dict

Returns

variable definition info

return_ds_format_variable_names(ds_format)¶

Returns variables for specified ds format

Parameters: ds_format (str) – product format string (value returned by self.return_ds_formats())
Return type: List[str]
Returns: ds format variables

return_ds_formats()¶

Returns available ds format names