geoips.dev package#

Submodules#

geoips.dev.output_config module#

Interpolation interface will be deprecated v2.0.

Wrapper functions for geoips output_config specifications.

This functionality will be replaced with a class-based implementation v2.0, and deprecated at that time.

geoips.dev.output_config.get_filename_formatter_kwargs(filename_formatter, output_dict)[source]#

Interface will be deprecated v2.0.

Return dictionary of filename_formatters_kwargs.

based on what was passed in via the YAML output config dictionary, as well as default kwargs.

If “filename_formatter_kwargs (singular) is passed command line, use that to override ALL filename_formatters_kwargs specified in YAML output config.

geoips.dev.output_config.get_filename_formatters(output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_metadata_filename_formatter(filename_formatter, output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_metadata_filename_formatter_kwargs(filename_formatter, output_dict)[source]#

Interface will be deprecated v2.0.

Return dictionary of filename_formatters_kwargs.

based on what was passed in via the YAML output config dictionary, as well as default kwargs

geoips.dev.output_config.get_metadata_output_formatter(output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_metadata_output_formatter_kwargs(output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_minimum_coverage(product_name, output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_output_config_type(output_config_dict)[source]#

Interface will be deprecated v2.0.

Retrieve output_config_type of the passed output_config_dict, found in:

output_config_dict[‘output_config_type’]

See: geoips.dev.output_config.is_valid_output_config for full list of supported output_config types.

Parameters:

output_config_dict (dict) – dictionary of complete output config parameters

Returns:

(str)

Return type:

output_config type, found in output_config_dict[‘output_config_type’]

geoips.dev.output_config.get_output_formatter(output_dict)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.get_output_formatter_kwargs(output_dict, xarray_obj=None, area_def=None, sector_type=None, bg_files=None, bg_xarrays=None, bg_product_name=None)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.is_valid_output_config(output_config_dict)[source]#

Interface will be deprecated v2.0.

Check that requested output_config dictionary is properly formatted.

The dictionary of output_config parameters fully determines the outputs required for a given set of data files.

Dictionary of output_config parameters currently specified by a full path to a YAML file: and requested via commandline with: --output_config <full_path_to_YAML_output_config>

Parameters:

output_config_dict (dict) – Dictionary of output config parameters

Returns:

is_valid –

  • True if output_config_dict is a properly formatted dictionary of output parameters.

  • False if output_config_dict:

    • does not contain supported output_config_type,

    • does not contain all required fields,

    • contains non-supported optional fields

Return type:

bool

Notes

output_config_types currently one of:

  • single_source

  • fused

geoips.dev.output_config.produce_current_time(config_dict, metadata_xobj, output_dict_keys=None)[source]#

Interface will be deprecated v2.0.

Determine if the current data file needs to be processed,

based on the requested times.

If output_dict_key is included, apply to only the currently

requested output_dict.

If output_dict_key is None, check ALL outputs to determine if

ANY need the current time.

geoips.dev.output_config.set_lonlat_spacing(gridline_annotator, area_def)[source]#

Interface will be deprecated v2.0.

geoips.dev.output_config.test_output_config_interface(output_config_dict)[source]#

Interface will be deprecated v2.0.

Finds and opens every product params dict available within the current geoips instantiation

See geoips.dev.output_config.is_valid_output_config?

for a list of available product params dict types and associated call signatures / return values.

Returns:

List of all successful output_config information

Return type:

list

geoips.dev.product module#

Interpolation interface will be deprecated v2.0.

Wrapper functions for geoips product specifications.

This functionality will be replaced with a class-based implementation v2.0, and deprecated at that time.

geoips.dev.product.get_cmap_from_product(prod_plugin, output_dict=None)[source]#

Interface will be deprecated v2.0.

Retrieve colormapper information, based on requested product and source

Parameters:

  • product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

  • source_name (str) – Name of requested source (ie, ‘ahi’, ‘modis’, etc)

Returns:

cmap_func(**cmap_args) – Return actual colormapper information

Return type:

function

See also

geoips.dev.check_cmap_func

additional information on colormapper types, arguments, and return values

geoips.dev.product.get_covg_args_from_product(prod_plugin, output_dict=None, covg_field=None)[source]#

Interface will be deprecated v2.0.

Retrieve coverage check function args, based on requested product and source

Parameters:

  • product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

  • source_name (str) – Name of requested source (ie, ‘ahi’, ‘modis’, etc)

Returns:

covg_func_name – Return dictionary of coverage args required for given product/source

Return type:

str

See also

geoips.dev.check_cmap_func

additional information on colormapper types, arguments, and return values

geoips.dev.product.get_covg_from_product(prod_plugin, output_dict=None, covg_field=None)[source]#

Interface will be deprecated v2.0.

Retrieve coverage check function name, based on requested product and source

Parameters:

  • product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

  • source_name (str) – Name of requested source (ie, ‘ahi’, ‘modis’, etc)

Returns:

covg_func_name – Return name of coverage function required for given product/source

Return type:

str

See also

geoips.dev.check_cmap_func

additional information on colormapper types, arguments, and return values

geoips.dev.product.get_data_range(prod_plugin, output_dict=None)[source]#

Interface will be deprecated v2.0.

Retrieve required data range for requested product

Parameters:

product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

Returns:

data_range – List of float specifying min and max value for the output product <geoips_package>.algorithms.<algorithm_name>.alg_params['output_data_range']

Return type:

list

geoips.dev.product.get_product_display_name(prod_plugin, output_dict=None)[source]#

Interface will be deprecated v2.0.

Retrieve product display name. For titles, etc.

Parameters:

  • product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

  • source_name (str) – Name of requested source (ie, ‘ahi’, ‘modis’, etc)

Returns:

product_display_name – Return display name for given product

Return type:

str

See also

geoips.dev.check_cmap_func

additional information on colormapper types, arguments, and return values

geoips.dev.product.get_requested_datasets_for_variables(prod_plugin)[source]#

Interface will be deprecated v2.0.

Retrieve required datasets if specified for product variables, based on requested product and source

Within product_inputs YAML specifications, variables can be requested with <DATASET>:<VARNAME> if you need a particular variable from a specific dataset.

If <DATASET>: is not specified, the first variable found when looping through the datasets is used.

Parameters:

  • product_name (str) – Name of requested product (ie, ‘IR-BD’, ‘89H’, ‘color89Nearest’, etc)

  • source_name (str) – Name of requested source (ie, ‘ahi’, ‘modis’, etc)

Returns:

datasets_for_variable –

  • Dictionary of

    • {'<variable_name>': '<requested_dataset>'} OR

    • {'variable_type': {'<variable_name>': '<requested_dataset>'}

Return type:

dict

geoips.dev.product.get_required_variables(prod_plugin)[source]#

Interface will be deprecated v2.0.

Return required variables names for the input product plugin. If variables are combined with their dataset name, the dataset name will be stripped and only the variable names will be returned.

Parameters:

prod_plugin (ProductPlugin) – An instance of the GeoIPS ProductPlugin class.

Returns:

required_variables –

  • If list: List of strings specifying required variables.

  • If dict: Dictionary of variable types of lists of variable names

    • {‘<variable_type>’: [‘var1’, ‘var2’, … , ‘varn’]}

Return type:

list or dict

Module contents#

dev init file.