radar_api.utils package

Contents

radar_api.utils package#

Submodules#

radar_api.utils.list module#

This module contains functions for list processing.

radar_api.utils.list.flatten_list(nested_list)[source][source]#: Flatten a nested list into a single-level list.

radar_api.utils.timing module#

Define timing utilities.

radar_api.utils.timing.print_elapsed_time(fn)[source][source]#: Timing decorator.

radar_api.utils.xradar module#

This module include xradar utilities.

radar_api.utils.xradar.get_mch_datatree_from_pyart(radar_obj)[source][source]#: Convert a pyart object to xradar datatree.

radar_api.utils.xradar.get_nexrad_datatree_from_pyart(radar_obj)[source][source]#: Convert a pyart object to xradar datatree.

radar_api.utils.yaml module#

This module defines a YAML file reader and writer.

radar_api.utils.yaml.read_yaml(filepath: str) → dict[source][source]#

Read a YAML file into a dictionary.

Parameters:: filepath (str) – Input YAML file path.
Returns:: Dictionary with the attributes read from the YAML file.
Return type:: dict

radar_api.utils.yaml.write_yaml(dictionary, filepath, sort_keys=False)[source][source]#

Write a dictionary into a YAML file.

Parameters:: dictionary (dict) – Dictionary to write into a YAML file.

Module contents#

Utilities for RADAR-API.