gpm package

Subpackages

• gpm.accessor package
  • Submodules
  • gpm.accessor.methods module
    • GPM_Base_Accessor
      • GPM_Base_Accessor.collocate()
      • GPM_Base_Accessor.crop()
      • GPM_Base_Accessor.crop_by_continent()
      • GPM_Base_Accessor.crop_by_country()
      • GPM_Base_Accessor.define_transect_slices()
      • GPM_Base_Accessor.end_time
      • GPM_Base_Accessor.extent()
      • GPM_Base_Accessor.get_crop_slices_by_continent()
      • GPM_Base_Accessor.get_crop_slices_by_country()
      • GPM_Base_Accessor.get_crop_slices_by_extent()
      • GPM_Base_Accessor.get_height_at_bin()
      • GPM_Base_Accessor.get_slices_contiguous_granules()
      • GPM_Base_Accessor.get_slices_contiguous_scans()
      • GPM_Base_Accessor.get_slices_regular()
      • GPM_Base_Accessor.get_slices_regular_time()
      • GPM_Base_Accessor.get_slices_valid_geolocation()
      • GPM_Base_Accessor.get_variable_at_bin()
      • GPM_Base_Accessor.has_contiguous_scans
      • GPM_Base_Accessor.has_missing_granules
      • GPM_Base_Accessor.has_regular_time
      • GPM_Base_Accessor.has_valid_geolocation
      • GPM_Base_Accessor.is_grid
      • GPM_Base_Accessor.is_orbit
      • GPM_Base_Accessor.is_regular
      • GPM_Base_Accessor.is_spatial_2d
      • GPM_Base_Accessor.is_spatial_3d
      • GPM_Base_Accessor.plot_map_mesh()
      • GPM_Base_Accessor.plot_map_mesh_centroids()
      • GPM_Base_Accessor.plot_swath()
      • GPM_Base_Accessor.plot_swath_lines()
      • GPM_Base_Accessor.plot_transect_line()
      • GPM_Base_Accessor.pyresample_area
      • GPM_Base_Accessor.remap_on()
      • GPM_Base_Accessor.select_transect()
      • GPM_Base_Accessor.slice_range_at_height()
      • GPM_Base_Accessor.slice_range_at_max_value()
      • GPM_Base_Accessor.slice_range_at_min_value()
      • GPM_Base_Accessor.slice_range_at_value()
      • GPM_Base_Accessor.slice_range_where_values()
      • GPM_Base_Accessor.slice_range_with_valid_data()
      • GPM_Base_Accessor.spatial_dimensions
      • GPM_Base_Accessor.start_time
      • GPM_Base_Accessor.subset_by_time()
      • GPM_Base_Accessor.subset_by_time_slice()
      • GPM_Base_Accessor.vertical_dimension
    • GPM_DataArray_Accessor
      • GPM_DataArray_Accessor.get_slices_var_between()
      • GPM_DataArray_Accessor.get_slices_var_equals()
      • GPM_DataArray_Accessor.integrate_profile_concentration()
      • GPM_DataArray_Accessor.plot_image()
      • GPM_DataArray_Accessor.plot_map()
      • GPM_DataArray_Accessor.plot_transect()
      • GPM_DataArray_Accessor.title()
    • GPM_Dataset_Accessor
      • GPM_Dataset_Accessor.available_retrievals()
      • GPM_Dataset_Accessor.frequency_variables
      • GPM_Dataset_Accessor.plot_image()
      • GPM_Dataset_Accessor.plot_map()
      • GPM_Dataset_Accessor.plot_transect()
      • GPM_Dataset_Accessor.retrieve()
      • GPM_Dataset_Accessor.select_spatial_2d_variables()
      • GPM_Dataset_Accessor.select_spatial_3d_variables()
      • GPM_Dataset_Accessor.set_encoding()
      • GPM_Dataset_Accessor.slice_range_at_temperature()
      • GPM_Dataset_Accessor.spatial_2d_variables
      • GPM_Dataset_Accessor.spatial_3d_variables
      • GPM_Dataset_Accessor.title()
      • GPM_Dataset_Accessor.to_dask_dataframe()
      • GPM_Dataset_Accessor.to_pandas_dataframe()
      • GPM_Dataset_Accessor.variables
  • Module contents
    • GPM_DataArray_Accessor
      • GPM_DataArray_Accessor.get_slices_var_between()
      • GPM_DataArray_Accessor.get_slices_var_equals()
      • GPM_DataArray_Accessor.integrate_profile_concentration()
      • GPM_DataArray_Accessor.plot_image()
      • GPM_DataArray_Accessor.plot_map()
      • GPM_DataArray_Accessor.plot_transect()
      • GPM_DataArray_Accessor.title()
    • GPM_Dataset_Accessor
      • GPM_Dataset_Accessor.available_retrievals()
      • GPM_Dataset_Accessor.frequency_variables
      • GPM_Dataset_Accessor.plot_image()
      • GPM_Dataset_Accessor.plot_map()
      • GPM_Dataset_Accessor.plot_transect()
      • GPM_Dataset_Accessor.retrieve()
      • GPM_Dataset_Accessor.select_spatial_2d_variables()
      • GPM_Dataset_Accessor.select_spatial_3d_variables()
      • GPM_Dataset_Accessor.set_encoding()
      • GPM_Dataset_Accessor.slice_range_at_temperature()
      • GPM_Dataset_Accessor.spatial_2d_variables
      • GPM_Dataset_Accessor.spatial_3d_variables
      • GPM_Dataset_Accessor.title()
      • GPM_Dataset_Accessor.to_dask_dataframe()
      • GPM_Dataset_Accessor.to_pandas_dataframe()
      • GPM_Dataset_Accessor.variables
• gpm.bucket package
  • Submodules
  • gpm.bucket.analysis module
    • get_cut_lat_breaks_labels()
    • get_cut_lon_breaks_labels()
    • get_lat_bins()
    • get_lat_labels()
    • get_lon_bins()
    • get_lon_labels()
    • get_n_decimals()
    • pl_add_geographic_bins()
    • pl_df_to_xarray()
  • gpm.bucket.dataset module
    • write_partitioned_dataset()
  • gpm.bucket.io module
    • get_filepaths_by_bin()
  • gpm.bucket.processing module
    • assign_spatial_partitions()
    • convert_size_to_bytes()
    • drop_undesired_columns()
    • ds_to_dask_df_function()
    • ds_to_pd_df_function()
    • ensure_pyarrow_string_columns()
    • ensure_unique_chunking()
    • estimate_row_group_size()
    • get_bin_partition()
    • get_df_object_columns()
    • has_unique_chunking()
  • gpm.bucket.readers module
    • read_partitioned_dataset()
  • gpm.bucket.utils module
    • add_bin_column()
    • add_spatial_bins()
    • create_spatial_bin_empty_df()
  • gpm.bucket.writers module
    • split_list_in_blocks()
    • write_granule_bucket()
  • Module contents
• gpm.dataset package
  • Subpackages
    • gpm.dataset.decoding package
      • Submodules
      • gpm.dataset.decoding.cf module
      • gpm.dataset.decoding.coordinates module
      • gpm.dataset.decoding.dataarray_attrs module
      • gpm.dataset.decoding.decode_1c_pmw module
      • gpm.dataset.decoding.decode_2a_pmw module
      • gpm.dataset.decoding.decode_2a_radar module
      • gpm.dataset.decoding.decode_imerg module
      • gpm.dataset.decoding.routines module
      • gpm.dataset.decoding.utils module
      • Module contents
  • Submodules
  • gpm.dataset.attrs module
    • add_history()
    • decode_attrs()
    • decode_string()
    • get_granule_attrs()
  • gpm.dataset.conventions module
    • finalize_dataset()
    • reshape_dataset()
  • gpm.dataset.coords module
    • get_coords()
    • get_coords_attrs_dict()
    • get_grid_coords()
    • get_orbit_coords()
    • get_time_delta_from_time_interval()
    • set_coords_attrs()
  • gpm.dataset.crs module
    • get_pyproj_crs()
    • get_pyresample_area()
    • get_pyresample_projection()
    • get_pyresample_swath()
    • has_proj_coords()
    • has_swath_coords()
    • remove_existing_crs_info()
    • set_dataset_crs()
    • set_dataset_single_crs()
    • simplify_grid_mapping_values()
  • gpm.dataset.dataset module
    • open_dataset()
  • gpm.dataset.datatree module
    • check_non_empty_granule()
    • check_valid_granule()
    • open_datatree()
  • gpm.dataset.dimensions module
  • gpm.dataset.granule module
    • get_variables()
    • get_variables_dims()
    • open_granule()
    • remove_unused_var_dims()
    • unused_var_dims()
  • gpm.dataset.groups_variables module
  • Module contents
• gpm.encoding package
  • Submodules
  • gpm.encoding.encode_2a_radar module
    • get_encoding_dict()
  • gpm.encoding.encode_imerg_v7 module
    • get_encoding_dict()
  • gpm.encoding.routines module
    • get_product_encoding_dict()
    • set_encoding()
  • Module contents
• gpm.etc package
  • Module contents
• gpm.io package
  • Submodules
  • gpm.io.checks module
    • check_base_dir()
    • check_date()
    • check_filepaths()
    • check_full_product_level()
    • check_full_product_levels()
    • check_groups()
    • check_product()
    • check_product_categories()
    • check_product_category()
    • check_product_level()
    • check_product_levels()
    • check_product_type()
    • check_product_types()
    • check_product_validity()
    • check_product_version()
    • check_remote_storage()
    • check_satellite()
    • check_satellites()
    • check_scan_mode()
    • check_sensor()
    • check_sensors()
    • check_start_end_time()
    • check_storage()
    • check_time()
    • check_transfer_tool()
    • check_transfer_tool_availability()
    • check_valid_time_request()
    • check_variables()
    • check_version()
    • check_versions()
  • gpm.io.data_integrity module
    • check_archive_integrity()
    • check_filepaths_integrity()
    • get_corrupted_filepaths()
    • remove_corrupted_filepaths()
  • gpm.io.download module
    • check_pps_available()
    • check_pps_ports_are_open()
    • check_valid_pps_credentials()
    • curl_ges_disc_cmd()
    • curl_pps_cmd()
    • download_archive()
    • download_files()
    • filter_download_list()
    • get_curl_version()
    • get_filepath_from_filename()
    • get_filepaths_from_filenames()
    • run()
    • wget_ges_disc_cmd()
    • wget_pps_cmd()
  • gpm.io.filter module
    • filter_by_product()
    • filter_by_time()
    • filter_by_version()
    • filter_filepaths()
    • is_granule_within_time()
  • gpm.io.find module
    • find_associated_filepath()
    • find_daily_filepaths()
    • find_filepaths()
  • gpm.io.ges_disc module
    • define_ges_disc_filepath()
    • get_ges_disc_daily_filepaths()
    • get_ges_disc_product_directory()
    • get_ges_disc_product_directory_tree()
  • gpm.io.info module
    • get_end_time_from_filepaths()
    • get_granule_from_filepaths()
    • get_info_from_filepath()
    • get_key_from_filepath()
    • get_key_from_filepaths()
    • get_product_from_filepath()
    • get_product_from_filepaths()
    • get_start_end_time_from_filepaths()
    • get_start_time_from_filepaths()
    • get_version_from_filepath()
    • get_version_from_filepaths()
  • gpm.io.local module
    • define_local_filepath()
    • get_local_daily_filepaths()
    • get_local_dir_tree_from_filename()
    • get_local_filepath_from_filename()
    • get_local_filepaths()
    • get_local_product_directory()
    • get_time_tree()
    • group_filepaths_by_time_group()
    • list_files()
    • list_paths()
  • gpm.io.pps module
    • define_pps_filepath()
    • find_first_pps_granule_filepath()
    • get_pps_daily_filepaths()
    • get_pps_product_directory()
  • gpm.io.products module
    • available_product_categories()
    • available_product_levels()
    • available_product_versions()
    • available_products()
    • available_satellites()
    • available_scan_modes()
    • available_sensors()
    • available_versions()
    • filter_info_dict_by_time()
    • get_available_product_categories()
    • get_available_product_levels()
    • get_available_product_types()
    • get_available_products()
    • get_available_satellites()
    • get_available_sensors()
    • get_available_versions()
    • get_info_dict()
    • get_info_dict_subset()
    • get_last_product_version()
    • get_product_category()
    • get_product_end_time()
    • get_product_info()
    • get_product_level()
    • get_product_pattern()
    • get_product_start_time()
    • get_products_pattern_dict()
    • is_gpm_api_product()
    • is_trmm_product()
  • Module contents
• gpm.retrievals package
  • Submodules
  • gpm.retrievals.retrieval_2a_pmw module
    • retrieve_liquidPrecipitation()
    • retrieve_totalWaterPath()
  • gpm.retrievals.retrieval_2a_radar module
    • retrieve_EchoDepth()
    • retrieve_EchoTopHeight()
    • retrieve_HailKineticEnergy()
    • retrieve_MESH()
    • retrieve_POH()
    • retrieve_POSH()
    • retrieve_REFC()
    • retrieve_REFCH()
    • retrieve_SHI()
    • retrieve_VIL()
    • retrieve_VILD()
    • retrieve_dfrFinal()
    • retrieve_dfrFinalNearSurface()
    • retrieve_dfrMeasured()
    • retrieve_heightClutterFreeBottom()
    • retrieve_heightRealSurfaceKa()
    • retrieve_heightRealSurfaceKu()
    • retrieve_precipitationType()
  • gpm.retrievals.routines module
    • available_retrievals()
    • check_retrieval_validity()
    • get_retrieval_variable()
  • Module contents
• gpm.utils package
  • Submodules
  • gpm.utils.archive module
    • check_archive_completeness()
    • check_no_duplicated_files()
    • check_time_period_coverage()
    • get_time_period_with_missing_files()
  • gpm.utils.area module
    • get_quadmesh_vertices()
  • gpm.utils.checks module
    • apply_on_valid_geolocation()
    • check_contiguous_granules()
    • check_contiguous_scans()
    • check_missing_granules()
    • check_regular_time()
    • check_valid_geolocation()
    • get_missing_granule_numbers()
    • get_slices_contiguous_granules()
    • get_slices_contiguous_scans()
    • get_slices_non_contiguous_scans()
    • get_slices_non_regular_time()
    • get_slices_non_valid_geolocation()
    • get_slices_non_wobbling_swath()
    • get_slices_regular()
    • get_slices_regular_time()
    • get_slices_valid_geolocation()
    • get_slices_var_between()
    • get_slices_var_equals()
    • get_slices_wobbling_swath()
    • has_contiguous_granules()
    • has_contiguous_scans()
    • has_missing_granules()
    • has_regular_time()
    • has_valid_geolocation()
    • is_regular()
  • gpm.utils.collocation module
    • collocate_product()
  • gpm.utils.dask module
    • clean_memory()
    • get_client()
    • trim_memory()
  • gpm.utils.decorators module
    • check_has_along_track_dimension()
    • check_has_cross_track_dimension()
    • check_is_gpm_object()
    • check_is_grid()
    • check_is_orbit()
  • gpm.utils.geospatial module
    • Extent
      • Extent.xmax
      • Extent.xmin
      • Extent.ymax
      • Extent.ymin
    • crop()
    • crop_by_continent()
    • crop_by_country()
    • extend_geographic_extent()
    • get_continent_extent()
    • get_country_extent()
    • get_crop_slices_by_continent()
    • get_crop_slices_by_country()
    • get_crop_slices_by_extent()
    • get_extent()
    • read_continents_extent_dictionary()
    • read_countries_extent_dictionary()
    • unwrap_longitude_degree()
  • gpm.utils.list module
    • flatten_list()
  • gpm.utils.manipulations module
    • check_variable_availabilty()
    • create_bin_idx_data_array()
    • get_bright_band_mask()
    • get_dims_without()
    • get_height_at_bin()
    • get_height_at_temperature()
    • get_liquid_phase_mask()
    • get_range_axis()
    • get_range_index_at_max()
    • get_range_index_at_min()
    • get_range_index_at_value()
    • get_range_slices_with_valid_data()
    • get_range_slices_within_values()
    • get_solid_phase_mask()
    • get_variable_at_bin()
    • get_variable_dataarray()
    • get_xr_shape()
    • integrate_profile_concentration()
    • select_radar_frequency()
    • select_spatial_2d_variables()
    • select_spatial_3d_variables()
    • select_transect_variables()
    • slice_range_at_height()
    • slice_range_at_max_value()
    • slice_range_at_min_value()
    • slice_range_at_temperature()
    • slice_range_at_value()
    • slice_range_where_values()
    • slice_range_with_valid_data()
  • gpm.utils.parallel module
    • compute_list_delayed()
  • gpm.utils.pyresample module
    • get_pyresample_area()
    • remap()
  • gpm.utils.slices module
    • enlarge_slice()
    • enlarge_slices()
    • ensure_is_slice()
    • get_indices_from_list_slices()
    • get_list_slices_from_bool_arr()
    • get_list_slices_from_indices()
    • get_slice_from_idx_bounds()
    • get_slice_size()
    • list_slices_combine()
    • list_slices_difference()
    • list_slices_filter()
    • list_slices_flatten()
    • list_slices_intersection()
    • list_slices_simplify()
    • list_slices_sort()
    • list_slices_union()
    • pad_slice()
    • pad_slices()
  • gpm.utils.time module
    • ensure_time_validity()
    • get_dataset_start_end_time()
    • has_nat()
    • infill_timesteps()
    • interpolate_nat()
    • is_nat()
    • regularize_dataset()
    • subset_by_time()
    • subset_by_time_slice()
  • gpm.utils.timing module
    • print_elapsed_time()
    • print_task_elapsed_time()
  • gpm.utils.warnings module
    • GPMDownloadWarning
    • GPM_Warning
  • gpm.utils.yaml module
    • read_yaml()
    • write_yaml()
  • Module contents
• gpm.visualization package
  • Submodules
  • gpm.visualization.facetgrid module
    • CartopyFacetGrid
      • CartopyFacetGrid.optimize_layout()
      • CartopyFacetGrid.set_extent()
    • CustomFacetGrid
      • CustomFacetGrid.adapt_fig_size()
      • CustomFacetGrid.add_colorbar()
      • CustomFacetGrid.remove_duplicated_axis_labels()
      • CustomFacetGrid.remove_title_dimension_prefix()
      • CustomFacetGrid.set_title()
    • ImageFacetGrid
    • sanitize_facetgrid_plot_kwargs()
  • gpm.visualization.grid module
    • plot_grid_image()
    • plot_grid_map()
    • plot_grid_mesh()
  • gpm.visualization.orbit module
    • plot_orbit_image()
    • plot_orbit_map()
    • plot_orbit_mesh()
    • plot_swath()
    • plot_swath_lines()
  • gpm.visualization.plot module
    • adapt_fig_size()
    • add_map_inset()
    • add_optimize_layout_method()
    • create_grid_mesh_data_array()
    • get_antimeridian_mask()
    • get_dataarray_extent()
    • get_inset_bounds()
    • get_valid_pcolormesh_inputs()
    • infill_invalid_coords()
    • initialize_cartopy_plot()
    • is_generator()
    • plot_cartopy_background()
    • plot_colorbar()
    • plot_image()
    • plot_labels()
    • plot_map()
    • plot_map_mesh()
    • plot_map_mesh_centroids()
    • plot_patches()
    • plot_sides()
    • preprocess_figure_args()
    • preprocess_subplot_kwargs()
    • set_colorbar_fully_transparent()
  • gpm.visualization.plot_3d module
    • IsosurfaceSlider
      • IsosurfaceSlider.update()
    • OpacitySlider
    • OrthogonalSlicesSlider
      • OrthogonalSlicesSlider.update()
    • add_3d_isosurface_slider()
    • add_3d_isosurfaces()
    • add_3d_orthogonal_slices()
    • create_pyvista_2d_surface()
    • create_pyvista_3d_volume()
    • get_slider_button_positions()
  • gpm.visualization.profile module
    • get_transect_slices()
    • plot_transect()
    • plot_transect_line()
    • select_transect()
  • gpm.visualization.title module
    • get_dataarray_title()
    • get_dataset_title()
    • get_time_str()
  • Module contents
    • add_map_inset()
    • plot_image()
    • plot_labels()
    • plot_map()
    • plot_map_mesh()
    • plot_patches()

Submodules

gpm.checks module

This module defines functions providing GPM-API Dataset information.

gpm.checks.check_has_along_track_dimension(xr_obj)

gpm.checks.check_has_cross_track_dimension(xr_obj)

gpm.checks.check_is_gpm_object(xr_obj)

Check is a GPM object (GRID or ORBIT).

gpm.checks.check_is_grid(xr_obj)

Check is a GPM GRID object.

gpm.checks.check_is_orbit(xr_obj)

Check is a GPM ORBIT object.

gpm.checks.check_is_spatial_2d(da, strict=True, squeeze=True)

gpm.checks.check_is_spatial_3d(da, strict=True, squeeze=True)

gpm.checks.check_is_transect(da, strict=True, squeeze=True)

gpm.checks.check_is_xarray(x)

gpm.checks.check_is_xarray_dataarray(x)

gpm.checks.check_is_xarray_dataset(x)

gpm.checks.get_dataset_variables(ds, sort=False)

Get list of xr.Dataset variables.

gpm.checks.get_frequency_variables(ds)

Get list of xr.Dataset variables with frequency-related dimension.

gpm.checks.get_spatial_2d_variables(ds, strict=False, squeeze=True)

Get list of xr.Dataset 2D spatial variables.

gpm.checks.get_spatial_3d_variables(ds, strict=False, squeeze=True)

Get list of xr.Dataset 3D spatial variables.

gpm.checks.get_spatial_dimensions(xr_obj)

Return the name of the spatial dimensions.

gpm.checks.get_transect_variables(ds, strict=False, squeeze=True)

Get list of xr.Dataset trasect variables.

gpm.checks.get_vertical_dimension(xr_obj)

Return the name of the vertical dimension.

gpm.checks.is_grid(xr_obj)

Check whether the GPM xarray object is a grid.

gpm.checks.is_orbit(xr_obj)

Check whether the GPM xarray object is an orbit.

gpm.checks.is_spatial_2d(xr_obj, strict=True, squeeze=True)

Check if is spatial 2d xarray object.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True (default), the DataArray must have just the 2D spatial dimensions. If strict=False, the DataArray can have additional dimensions (except vertical).

gpm.checks.is_spatial_3d(xr_obj, strict=True, squeeze=True)

Check if is spatial 3d xarray object.

gpm.checks.is_transect(xr_obj, strict=True, squeeze=True)

Check if is spatial profile xarray object.

gpm.configs module

GPM-API configurations settings.

gpm.configs.define_configs(base_dir: str | None = None, username_pps: str | None = None, password_pps: str | None = None, username_earthdata: str | None = None, password_earthdata: str | None = None)

Defines the GPM-API configuration file with the given credentials and base directory.

Parameters:

• base_dir (str) – The base directory where GPM data are stored.

• username_pps (str, optional) – The username for the NASA GPM PPS account.

• password_pps (str, optional) – The password for the NASA GPM PPS account.

• username_earthdata (str, optional) – The username for the NASA EarthData account.

• password_earthdata (str, optional) – The password for the NASA EarthData account.

Notes

This function writes a YAML file to the user’s home directory at ~/.config_gpm.yaml with the given GPM-API credentials and base directory. The configuration file can be used for authentication when making GPM-API requests.

gpm.configs.get_base_dir(base_dir=None)

Return the GPM base directory.

gpm.configs.get_password_earthdata()

Return the GPM-API EarthData password.

gpm.configs.get_password_pps()

Return the GPM-API PPS password.

gpm.configs.get_username_earthdata()

Return the GPM-API EarthData username.

gpm.configs.get_username_pps()

Return the GPM-API PPS username.

gpm.configs.read_configs() → dict[str, str]

Reads the GPM-API configuration file and returns a dictionary with the configuration settings.

Returns:

A dictionary containing the configuration settings for the GPM-API, including the username, password, and GPM base directory.

Return type:

dict

Raises:

ValueError – If the configuration file has not been defined yet. Use gpm.define_configs() to specify the configuration file path and settings.

Notes

This function reads the YAML configuration file located at ~/.config_gpm.yaml, which should contain the GPM-API credentials and base directory specified by gpm.define_configs().

gpm.configs.set_ges_disc_authentification(username, password)

Create authentication files for access to the GES DISC Data Archive.

Follow the additional steps detailed at https://disc.gsfc.nasa.gov/earthdata-login to enable access to the GES DISC HTTPS Data Archive.

The code snippet is taken from https://disc.gsfc.nasa.gov/information/howto?title=How%20to%20Generate%20Earthdata%20Prerequisite%20Files

Parameters:

• username (str) – EarthData login username.

• password (TYPE) – EarthData login password.

Return type:

None.

Module contents

GPM-API Package.