gpm package

Subpackages

• gpm.accessor package
  • Submodules
  • gpm.accessor.methods module
    • GPM_Base_Accessor
      • GPM_Base_Accessor.broadcast_like()
      • GPM_Base_Accessor.cartopy_crs
      • GPM_Base_Accessor.collocate()
      • GPM_Base_Accessor.crop()
      • GPM_Base_Accessor.crop_around_point()
      • GPM_Base_Accessor.crop_around_valid_data()
      • GPM_Base_Accessor.crop_by_continent()
      • GPM_Base_Accessor.crop_by_country()
      • GPM_Base_Accessor.end_time
      • GPM_Base_Accessor.extent()
      • GPM_Base_Accessor.extract_at_points()
      • GPM_Base_Accessor.extract_transect_along_dimension()
      • GPM_Base_Accessor.extract_transect_around_point()
      • GPM_Base_Accessor.extract_transect_at_points()
      • GPM_Base_Accessor.extract_transect_between_points()
      • GPM_Base_Accessor.get_crop_slices_around_point()
      • 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.has_contiguous_scans
      • GPM_Base_Accessor.has_missing_granules
      • GPM_Base_Accessor.has_regular_time
      • GPM_Base_Accessor.has_valid_geolocation
      • GPM_Base_Accessor.infill_below_bin()
      • 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.isel()
      • GPM_Base_Accessor.mask_above_bin()
      • GPM_Base_Accessor.mask_below_bin()
      • GPM_Base_Accessor.mask_between_bins()
      • 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.pyproj_crs
      • GPM_Base_Accessor.pyresample_area
      • GPM_Base_Accessor.quadmesh_centroids()
      • GPM_Base_Accessor.quadmesh_corners()
      • GPM_Base_Accessor.quadmesh_polygons()
      • GPM_Base_Accessor.quadmesh_vertices()
      • GPM_Base_Accessor.remap_era5()
      • GPM_Base_Accessor.remap_on()
      • GPM_Base_Accessor.sel()
      • GPM_Base_Accessor.set_crs()
      • GPM_Base_Accessor.slice_range_at_bin()
      • 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.spatial_coordinates
      • 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.subset_range_where_values()
      • GPM_Base_Accessor.subset_range_with_valid_data()
      • GPM_Base_Accessor.unstack_dimension()
      • GPM_Base_Accessor.vertical_dimension
      • GPM_Base_Accessor.x
      • GPM_Base_Accessor.y
    • GPM_DataArray_Accessor
      • GPM_DataArray_Accessor.decibel
      • GPM_DataArray_Accessor.get_slices_var_between()
      • GPM_DataArray_Accessor.get_slices_var_equals()
      • GPM_DataArray_Accessor.idecibel
      • GPM_DataArray_Accessor.integrate_profile_concentration()
      • GPM_DataArray_Accessor.locate_max_value()
      • GPM_DataArray_Accessor.locate_min_value()
      • GPM_DataArray_Accessor.plot_cross_section()
      • GPM_DataArray_Accessor.plot_image()
      • GPM_DataArray_Accessor.plot_map()
      • GPM_DataArray_Accessor.title()
    • GPM_DataTree_Accessor
      • GPM_DataTree_Accessor.regrid_pmw_l1()
    • GPM_Dataset_Accessor
      • GPM_Dataset_Accessor.available_retrievals()
      • GPM_Dataset_Accessor.bin_variables
      • GPM_Dataset_Accessor.cross_section_variables
      • GPM_Dataset_Accessor.extract_dataset_above_bin()
      • GPM_Dataset_Accessor.extract_dataset_below_bin()
      • GPM_Dataset_Accessor.extract_l2_dataset()
      • GPM_Dataset_Accessor.frequency_variables
      • GPM_Dataset_Accessor.plot_cross_section()
      • GPM_Dataset_Accessor.plot_image()
      • GPM_Dataset_Accessor.plot_map()
      • GPM_Dataset_Accessor.retrieve()
      • GPM_Dataset_Accessor.select_bin_variables()
      • GPM_Dataset_Accessor.select_cross_section_variables()
      • GPM_Dataset_Accessor.select_frequency_variables()
      • GPM_Dataset_Accessor.select_spatial_2d_variables()
      • GPM_Dataset_Accessor.select_spatial_3d_variables()
      • GPM_Dataset_Accessor.select_vertical_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_Dataset_Accessor.vertical_variables
    • auto_wrap_docstring()
    • get_imported_gpm_method()
    • get_imported_gpm_method_path()
  • Module contents
    • GPM_DataArray_Accessor
      • GPM_DataArray_Accessor.decibel
      • GPM_DataArray_Accessor.get_slices_var_between()
      • GPM_DataArray_Accessor.get_slices_var_equals()
      • GPM_DataArray_Accessor.idecibel
      • GPM_DataArray_Accessor.integrate_profile_concentration()
      • GPM_DataArray_Accessor.locate_max_value()
      • GPM_DataArray_Accessor.locate_min_value()
      • GPM_DataArray_Accessor.plot_cross_section()
      • GPM_DataArray_Accessor.plot_image()
      • GPM_DataArray_Accessor.plot_map()
      • GPM_DataArray_Accessor.title()
    • GPM_Dataset_Accessor
      • GPM_Dataset_Accessor.available_retrievals()
      • GPM_Dataset_Accessor.bin_variables
      • GPM_Dataset_Accessor.cross_section_variables
      • GPM_Dataset_Accessor.extract_dataset_above_bin()
      • GPM_Dataset_Accessor.extract_dataset_below_bin()
      • GPM_Dataset_Accessor.extract_l2_dataset()
      • GPM_Dataset_Accessor.frequency_variables
      • GPM_Dataset_Accessor.plot_cross_section()
      • GPM_Dataset_Accessor.plot_image()
      • GPM_Dataset_Accessor.plot_map()
      • GPM_Dataset_Accessor.retrieve()
      • GPM_Dataset_Accessor.select_bin_variables()
      • GPM_Dataset_Accessor.select_cross_section_variables()
      • GPM_Dataset_Accessor.select_frequency_variables()
      • GPM_Dataset_Accessor.select_spatial_2d_variables()
      • GPM_Dataset_Accessor.select_spatial_3d_variables()
      • GPM_Dataset_Accessor.select_vertical_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_Dataset_Accessor.vertical_variables
• gpm.bucket package
  • Submodules
  • gpm.bucket.analysis module
    • add_overpass_id()
    • count_overpass_occurence()
    • ensure_start_end_time_interval()
    • get_list_overpass_time()
    • get_swath_indices()
    • overpass_to_dataset()
    • split_by_overpass()
  • gpm.bucket.dataframe module
    • check_valid_dataframe()
    • df_add_column()
    • df_get_column()
    • df_is_column_in()
    • df_select_valid_rows()
    • df_to_pandas()
    • pl_cut()
  • gpm.bucket.filters module
    • apply_spatial_filters()
    • filter_around_point()
    • filter_by_extent()
    • get_geodesic_distance_from_point()
  • gpm.bucket.io module
    • get_bucket_spatial_partitioning()
    • get_bucket_temporal_partitioning()
    • get_exisiting_partitions_paths()
    • get_filepaths()
    • get_filepaths_by_partition()
    • get_partitions_paths()
    • read_bucket_info()
    • write_bucket_info()
  • gpm.bucket.partitioning module
    • Base2DPartitioning
      • Base2DPartitioning.add_centroids()
      • Base2DPartitioning.add_labels()
      • Base2DPartitioning.bounds
      • Base2DPartitioning.centroids
      • Base2DPartitioning.directories
      • Base2DPartitioning.directories_around_point()
      • Base2DPartitioning.directories_by_extent()
      • Base2DPartitioning.get_partitions_around_point()
      • Base2DPartitioning.get_partitions_by_extent()
      • Base2DPartitioning.labels
      • Base2DPartitioning.quadmesh_corners()
      • Base2DPartitioning.query_centroids()
      • Base2DPartitioning.query_centroids_by_indices()
      • Base2DPartitioning.query_indices()
      • Base2DPartitioning.query_labels()
      • Base2DPartitioning.query_labels_by_indices()
      • Base2DPartitioning.query_vertices()
      • Base2DPartitioning.query_vertices_by_indices()
      • Base2DPartitioning.to_shapely()
      • Base2DPartitioning.to_xarray()
      • Base2DPartitioning.vertices()
    • LonLatPartitioning
      • LonLatPartitioning.dataset_grid
      • LonLatPartitioning.directories_around_point()
      • LonLatPartitioning.directories_by_continent()
      • LonLatPartitioning.directories_by_country()
      • LonLatPartitioning.get_partitions_around_point()
      • LonLatPartitioning.get_partitions_by_continent()
      • LonLatPartitioning.get_partitions_by_country()
    • TilePartitioning
      • TilePartitioning.to_dict()
    • XYPartitioning
      • XYPartitioning.dataset_grid()
      • XYPartitioning.to_dict()
      • XYPartitioning.x_labels
      • XYPartitioning.y_labels
    • check_default_levels()
    • check_partitioning_flavor()
    • check_partitioning_order()
    • check_valid_x_y()
    • flatten_indices_arrays()
    • flatten_xy_arrays()
    • get_array_combinations()
    • get_bounds()
    • get_centroids_from_bounds()
    • get_directories()
    • get_n_decimals()
    • get_partition_dir_name()
    • get_tile_id_labels()
    • get_tile_xy_labels()
    • justify_labels()
    • mask_invalid_indices()
    • np_broadcast_like()
    • query_indices()
  • gpm.bucket.readers module
    • check_backend()
    • read_bucket()
    • read_dask_partitioned_dataset()
  • gpm.bucket.routines module
    • check_temporal_partitioning()
    • define_dataset_filter()
    • define_dict_partitions()
    • get_list_group_periods()
    • get_partitioning_boundaries()
    • get_template_table()
    • get_time_prefix()
    • group_files_by_time()
    • split_list_in_blocks()
    • write_granule_bucket()
  • gpm.bucket.writers module
    • convert_size_to_bytes()
    • estimate_row_group_size()
    • get_table_from_dask_dataframe_partition()
    • get_table_schema_without_partitions()
    • preprocess_writer_kwargs()
    • write_arrow_partitioned_dataset()
    • write_dask_partitioned_dataset()
    • write_dataset_metadata()
    • write_pandas_partitioned_dataset()
    • write_partitioned_dataset()
    • write_polars_partitioned_dataset()
  • Module contents
    • LonLatPartitioning
      • LonLatPartitioning.dataset_grid
      • LonLatPartitioning.directories_around_point()
      • LonLatPartitioning.directories_by_continent()
      • LonLatPartitioning.directories_by_country()
      • LonLatPartitioning.get_partitions_around_point()
      • LonLatPartitioning.get_partitions_by_continent()
      • LonLatPartitioning.get_partitions_by_country()
    • TilePartitioning
      • TilePartitioning.to_dict()
    • XYPartitioning
      • XYPartitioning.dataset_grid()
      • XYPartitioning.to_dict()
      • XYPartitioning.x_labels
      • XYPartitioning.y_labels
    • merge_granule_buckets()
    • read()
    • write_bucket()
    • write_granules_bucket()
• 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_1b_radar 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_2b_corra 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
    • add_gpm_api_product()
    • 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
    • compute_extent()
    • compute_pyresample_area_extent()
    • get_pyproj_crs()
    • get_pyresample_area()
    • get_pyresample_projection()
    • get_pyresample_swath()
    • get_spatial_coordinates()
    • get_x_coordinate()
    • get_y_coordinate()
    • 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()
    • open_datatree()
    • open_files()
  • gpm.dataset.datatree module
    • check_non_empty_granule()
    • check_valid_granule()
    • open_raw_datatree()
  • gpm.dataset.dimensions module
    • rename_dataarray_dimensions()
    • rename_dataset_dimensions()
    • rename_datatree_dimensions()
  • gpm.dataset.granule module
    • get_scan_modes_datasets()
    • get_variables()
    • get_variables_dims()
    • open_granule()
    • open_granule_dataset()
    • open_granule_datatree()
    • remove_unused_var_dims()
    • unused_var_dims()
  • gpm.dataset.groups_variables module
  • gpm.dataset.tcprimed module
    • convert_passive_microwave()
    • ensure_standard_longitude_values()
    • open_granule_tcprimed()
  • 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.gv package
  • Subpackages
    • gpm.gv.xradar package
      • Submodules
      • gpm.gv.xradar.accessors module
      • gpm.gv.xradar.methods module
      • Module contents
  • Submodules
  • gpm.gv.plots module
    • calibration_summary()
    • compare_maps()
    • plot_gdf_map()
    • reflectivity_distribution()
    • reflectivity_scatterplot()
    • reflectivity_scatterplots()
  • gpm.gv.routines module
    • add_radar_info()
    • antenna_to_cartesian()
    • convert_s_to_ku_band()
    • get_crs_center_latitude()
    • get_gr_crs()
    • plot_quicklook()
    • retrieve_ds_sr()
    • retrieve_gates_geographic_coordinates()
    • retrieve_gates_projection_coordinates()
    • xyz_to_antenna_coordinates()
  • Module contents
    • calibration_summary()
    • compare_maps()
    • reflectivity_distribution()
    • reflectivity_scatterplot()
    • reflectivity_scatterplots()
    • retrieve_ds_sr()
    • volume_matching()
• 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_scan_modes()
    • 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()
    • get_current_utc_time()
  • 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()
    • run_cmd_and_stream_output()
    • 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()
    • is_within_time_period()
  • 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
    • check_groups()
    • 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_season()
    • get_start_end_time_from_filepaths()
    • get_start_time_from_filepaths()
    • get_time_component()
    • get_version_from_filepath()
    • get_version_from_filepaths()
    • group_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()
  • 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_attributes_dict()
    • get_products_pattern_dict()
    • is_gpm_api_product()
    • is_trmm_product()
  • Module contents
• gpm.retrievals package
  • Submodules
  • gpm.retrievals.retrieval_1b_c_pmw module
    • retrieve_PCA_RGB()
    • retrieve_PCT()
    • retrieve_PD()
    • retrieve_PESCA()
    • retrieve_PR()
    • retrieve_UMAP_RGB()
    • retrieve_mwcc_hail_probability()
    • retrieve_polarization_corrected_temperature()
    • retrieve_polarization_difference()
    • retrieve_polarization_ratio()
    • retrieve_rgb_composites()
  • gpm.retrievals.retrieval_1b_radar module
    • get_dielectric_constant()
    • get_radar_wavelength()
    • open_dataset_1b_ka_fs()
    • resample_hs_to_fs()
    • retrieve_Psignal()
    • retrieve_ellipsoidBinOffset()
    • retrieve_geolocation_3d()
    • retrieve_height()
    • retrieve_range_distance_from_ellipsoid()
    • retrieve_range_distance_from_satellite()
    • retrieve_sampling_type()
    • retrieve_scRangeDEM()
    • retrieve_sigmaMeasured()
    • retrieve_signalPower()
    • retrieve_snRatio()
    • retrieve_zMeasured()
  • gpm.retrievals.retrieval_2a_pmw module
    • retrieve_liquidPrecipitation()
    • retrieve_totalWaterPath()
  • gpm.retrievals.retrieval_2a_radar module
    • get_nrange()
    • get_range_resolution()
    • retrieve_EchoDepth()
    • retrieve_EchoTopHeight()
    • retrieve_HailKineticEnergy()
    • retrieve_MESH()
    • retrieve_MESHS()
    • retrieve_POH()
    • retrieve_POSH()
    • retrieve_REFC()
    • retrieve_REFCH()
    • retrieve_SHI()
    • retrieve_VIL()
    • retrieve_VILD()
    • retrieve_bright_band_ratio()
    • retrieve_c_band_tan()
    • retrieve_dfrFinal()
    • retrieve_dfrFinalNearSurface()
    • retrieve_dfrMeasured()
    • retrieve_flagHydroClass()
    • retrieve_flagPrecipitationType()
    • retrieve_gate_resolution()
    • retrieve_gate_volume()
    • retrieve_heightClutterFreeBottom()
    • retrieve_heightRealSurfaceKa()
    • retrieve_heightRealSurfaceKu()
    • retrieve_range_distance_from_ellipsoid()
    • retrieve_range_distance_from_satellite()
    • retrieve_range_resolution()
    • retrieve_s_band_cao2013()
    • retrieve_x_band_tan()
  • gpm.retrievals.routines module
    • available_retrievals()
    • check_retrieval_validity()
    • get_retrieval_variable()
  • Module contents
    • open_dataset_1b_ka_fs()
• 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
    • geocentric_to_geographic()
    • geographic_to_geocentric()
    • get_centroids_from_corners()
    • get_corners_from_centroids()
    • get_corners_from_quadmesh()
    • get_lonlat_corners_from_1d_centroids()
    • get_lonlat_corners_from_centroids()
    • get_lonlat_quadmesh_vertices()
    • get_projection_centroids()
    • get_projection_corners_from_1d_centroids()
    • get_projection_corners_from_centroids()
    • get_projection_quadmesh_vertices()
    • get_quadmesh_centroids()
    • get_quadmesh_corners()
    • get_quadmesh_from_corners()
    • get_quadmesh_polygons()
    • get_quadmesh_vertices()
    • infer_interval_breaks()
    • is_clockwise()
    • preserve_dimension_order()
  • 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()
    • preprocess_datatree()
    • regrid_pmw_l1()
    • remap_era5()
  • gpm.utils.dask module
    • clean_memory()
    • close_dask_cluster()
    • get_client()
    • get_scheduler()
    • initialize_dask_cluster()
    • trim_memory()
  • gpm.utils.dataframe module
    • compute_2d_histogram()
    • drop_undesired_columns()
    • ensure_pyarrow_string_columns()
    • get_df_object_columns()
    • to_dask_dataframe()
    • to_pandas_dataframe()
  • gpm.utils.decorators module
    • check_has_along_track_dimension()
    • check_has_cross_track_dimension()
    • check_is_gpm_object()
    • check_is_grid()
    • check_is_orbit()
    • check_software_availability()
  • gpm.utils.directories module
    • check_glob_pattern()
    • check_glob_patterns()
    • get_filepaths_by_path()
    • get_filepaths_within_paths()
    • get_first_file()
    • get_parallel_dict_results()
    • get_parallel_list_results()
    • get_subdirectories()
    • list_and_filter_files()
    • list_directories()
    • list_files()
    • list_paths()
    • match_extension()
    • match_filters()
    • match_glob_pattern()
    • match_regex_pattern()
    • search_leaf_directories()
    • search_leaf_files()
  • gpm.utils.events module
    • get_event_slices()
    • group_indices_into_events()
    • remove_isolated_indices()
  • gpm.utils.geospatial module
    • Extent
      • Extent.xmax
      • Extent.xmin
      • Extent.ymax
      • Extent.ymin
    • adjust_extent()
    • adjust_geographic_extent()
    • check_extent()
    • crop()
    • crop_around_point()
    • crop_by_continent()
    • crop_by_country()
    • extend_extent()
    • extend_geographic_extent()
    • get_circle_coordinates_around_point()
    • get_continent_extent()
    • get_country_extent()
    • get_crop_slices_around_point()
    • get_crop_slices_by_continent()
    • get_crop_slices_by_country()
    • get_crop_slices_by_extent()
    • get_extent_around_point()
    • get_geodesic_line()
    • get_geographic_extent_around_point()
    • get_geographic_extent_from_xarray()
    • get_great_circle_arc_endpoints()
    • merge_extents()
    • read_continents_extent_dictionary()
    • read_countries_extent_dictionary()
    • unwrap_longitude_degree()
  • gpm.utils.list module
    • flatten_list()
  • gpm.utils.manipulations module
    • conversion_factors_degree_to_meter()
    • convert_from_decibel()
    • convert_to_decibel()
    • crop_around_valid_data()
    • define_transect_isel_dict()
    • ensure_vertical_datarray_prototype()
    • extract_at_points()
    • extract_dataset_above_bin()
    • extract_dataset_below_bin()
    • extract_l2_dataset()
    • extract_transect_along_dimension()
    • extract_transect_around_point()
    • extract_transect_at_points()
    • extract_transect_between_points()
    • get_bin_dataarray()
    • get_bright_band_mask()
    • get_height_at_bin()
    • get_height_at_temperature()
    • get_height_dataarray()
    • 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_spatial_2d_datarray_template()
    • get_spatial_3d_datarray_template()
    • get_vertical_coords_and_vars()
    • get_vertical_datarray_prototype()
    • infill_below_bin()
    • integrate_profile_concentration()
    • locate_max_value()
    • locate_min_value()
    • locate_points()
    • mask_above_bin()
    • mask_below_bin()
    • mask_between_bins()
    • mask_vertical_variables()
    • reverse_range()
    • select_bin_variables()
    • select_cross_section_variables()
    • select_frequency_variables()
    • select_spatial_2d_variables()
    • select_spatial_3d_variables()
    • select_vertical_variables()
    • slice_range_at_bin()
    • slice_range_at_height()
    • slice_range_at_max_value()
    • slice_range_at_min_value()
    • slice_range_at_temperature()
    • slice_range_at_value()
    • subset_range_where_values()
    • subset_range_with_valid_data()
  • gpm.utils.orbit module
    • adjust_short_sequences()
    • get_orbit_direction()
    • get_orbit_mode()
  • gpm.utils.parallel module
    • compute_list_delayed()
    • create_group_slices()
    • get_block_slices()
  • gpm.utils.pmw module
    • PMWFrequency
      • PMWFrequency.center_frequency
      • PMWFrequency.polarization
      • PMWFrequency.offset
      • PMWFrequency.center_frequency_str
      • PMWFrequency.from_string()
      • PMWFrequency.has_same_center_frequency()
      • PMWFrequency.has_same_offset()
      • PMWFrequency.has_same_polarization()
      • PMWFrequency.offset_str
      • PMWFrequency.opposite_polarization()
      • PMWFrequency.title()
      • PMWFrequency.to_string()
      • PMWFrequency.wavelength
    • available_pmw_frequencies()
    • create_rgb_composite()
    • find_closely_matching_center_frequency()
    • find_closely_matching_frequency()
    • find_polarization_pairs()
    • get_available_pct_features()
    • get_available_pd_features()
    • get_available_pr_features()
    • get_brightness_temperature()
    • get_frequencies_polarized_pairs()
    • get_pct()
    • get_pct_coefficient()
    • get_pd()
    • get_pmw_channel()
    • get_pmw_feature()
    • get_pmw_frequency()
    • get_pmw_frequency_dict()
    • get_pmw_rgb_receipts()
    • get_pr()
    • is_simple_feature_name()
    • normalize_channel()
    • strip_trailing_zero_decimals()
  • gpm.utils.pyresample module
    • get_cartopy_crs()
    • get_pyresample_area()
    • remap()
  • gpm.utils.remapping module
    • chunks_inputs()
    • reproject_coords()
  • 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.subsetting module
    • align_along_track()
    • align_cross_track()
    • is_1d_non_dimensional_coord()
    • isel()
    • sel()
  • 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.xarray module
    • broadcast_like()
    • check_is_xarray()
    • check_is_xarray_dataarray()
    • check_is_xarray_dataset()
    • check_variable_availabilty()
    • ensure_dim_order_dataarray()
    • ensure_dim_order_dataset()
    • ensure_unique_chunking()
    • get_dataset_variables()
    • get_default_variable()
    • get_dimensions_without()
    • get_xarray_variable()
    • has_unique_chunking()
    • squeeze_unsqueeze_dataarray()
    • squeeze_unsqueeze_dataset()
    • unstack_datarray_dimension()
    • unstack_dataset_dimension()
    • unstack_dimension()
    • xr_drop_constant_dimension()
    • xr_ensure_dimension_order()
    • xr_first()
    • xr_sorted_distribution()
    • xr_squeeze_unsqueeze()
  • gpm.utils.yaml module
    • NoAliasDumper
      • NoAliasDumper.ignore_aliases()
    • read_yaml()
    • write_yaml()
  • gpm.utils.zonal_stats module
    • BarnesGaussianWeights
      • BarnesGaussianWeights.get_weights()
      • BarnesGaussianWeights.set_size()
    • CressmanWeights
      • CressmanWeights.get_weights()
      • CressmanWeights.set_size()
    • InverseDistanceWeights
      • InverseDistanceWeights.get_weights()
      • InverseDistanceWeights.set_size()
    • PolyAggregator
      • PolyAggregator.apply()
      • PolyAggregator.average()
      • PolyAggregator.counts()
      • PolyAggregator.dict_distances
      • PolyAggregator.dict_intersection_areas
      • PolyAggregator.first()
      • PolyAggregator.fraction_covered_area()
      • PolyAggregator.list_distances
      • PolyAggregator.list_intersection_areas
      • PolyAggregator.max()
      • PolyAggregator.mean()
      • PolyAggregator.min()
      • PolyAggregator.n_source_polygons
      • PolyAggregator.n_target_polygons
      • PolyAggregator.source_centroids
      • PolyAggregator.source_polygons_areas
      • PolyAggregator.std()
      • PolyAggregator.sum()
      • PolyAggregator.target_centroids
      • PolyAggregator.target_intersecting_indices
      • PolyAggregator.target_non_intersecting_indices
      • PolyAggregator.target_polygons_areas
      • PolyAggregator.var()
    • create_list_indices()
    • create_target_dictionary()
    • split_dict()
  • Module contents
• gpm.visualization package
  • Submodules
  • gpm.visualization.animation module
    • check_frame_settings()
    • check_input_files()
    • check_mp4_codec()
    • check_mp4_optimization()
    • check_valid_dither()
    • create_apng()
    • create_ffmpeg_gif()
    • create_ffmpeg_mp4()
    • create_gifski_gif()
    • create_pillow_gif()
    • get_image_size()
  • gpm.visualization.cross_section module
    • get_cross_track_horizontal_distance()
    • plot_cross_section()
    • plot_transect_line()
  • gpm.visualization.eda module
    • plot_boxplot()
  • gpm.visualization.facetgrid module
    • CartopyFacetGrid
      • CartopyFacetGrid.optimize_layout()
      • CartopyFacetGrid.set_extent()
    • CustomFacetGrid
      • CustomFacetGrid.adapt_fig_size()
      • CustomFacetGrid.add_colorbar()
      • CustomFacetGrid.map_dataarray()
      • CustomFacetGrid.map_to_axes()
      • CustomFacetGrid.remove_bottom_ticks_and_labels()
      • CustomFacetGrid.remove_duplicated_axis_labels()
      • CustomFacetGrid.remove_left_ticks_and_labels()
      • CustomFacetGrid.remove_title_dimension_prefix()
      • CustomFacetGrid.remove_titles()
      • CustomFacetGrid.set_title()
    • ImageFacetGrid
    • get_cartopy_gridlines_artists()
    • sanitize_facetgrid_plot_kwargs()
  • gpm.visualization.grid module
    • plot_grid_map()
    • plot_grid_mesh()
  • gpm.visualization.orbit module
    • call_over_contiguous_scans()
    • infer_orbit_xy_dim()
    • plot_orbit_map()
    • plot_orbit_mesh()
    • plot_swath()
    • plot_swath_lines()
    • remove_invalid_outer_cross_track()
  • gpm.visualization.plot module
    • adapt_fig_size()
    • add_map_inset()
    • add_optimize_layout_method()
    • check_object_format()
    • create_grid_mesh_data_array()
    • get_antimeridian_mask()
    • get_valid_pcolormesh_inputs()
    • infer_map_xy_coords()
    • infer_xy_labels()
    • infill_invalid_coords()
    • initialize_cartopy_plot()
    • is_generator()
    • is_same_crs()
    • mask_antimeridian_crossing_array()
    • plot_cartopy_background()
    • plot_cartopy_gridlines_and_labels()
    • plot_cartopy_imshow()
    • plot_cartopy_pcolormesh()
    • plot_image()
    • plot_labels()
    • plot_map()
    • plot_map_mesh()
    • plot_map_mesh_centroids()
    • plot_patches()
    • plot_sides()
    • plot_xr_imshow()
    • plot_xr_pcolormesh()
    • preprocess_figure_args()
    • preprocess_rgb_dataarray()
    • preprocess_subplot_kwargs()
  • 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.quicklooks module
    • create_quicklooks_dataset()
    • create_quicklooks_datasets()
    • get_subplot_slices()
  • gpm.visualization.title module
    • get_dataarray_title()
    • get_dataset_title()
    • get_time_str()
  • Module contents
    • add_map_inset()
    • plot_cartopy_background()
    • plot_colorbar()
    • 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_dim(xr_obj, dim='along_track')

gpm.checks.check_has_cross_track_dim(xr_obj, dim='cross_track')

gpm.checks.check_has_frequency_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset has a frequency dimension.

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

gpm.checks.check_has_spatial_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset has at least one spatial horizontal dimension.

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

gpm.checks.check_has_vertical_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset have a vertical dimension.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=False (default), the xarray.DataArray can also have additional dimensions. If strict=True , the xarray.DataArray must have just the vertical dimension.

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

Check if the xarray.DataArray or xarray.Dataset is a cross-section.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True (default), the xarray.DataArray must have just the vertical dimension and a horizontal dimension. If strict=False , the xarray.DataArray can also have additional dimensions, but only a single vertical and horizontal dimension.

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(xr_obj, strict=True, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset is a spatial 2D field.

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

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

Check if the xarray.DataArray or xarray.Dataset is a spatial 3D field.

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

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

Check if the xarray.DataArray or xarray.Dataset is a transect.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True (default), the xarray.DataArray must have just an horizontal dimension. If strict=False , the xarray.DataArray can also have additional dimensions, but only an horizontal dimension.

gpm.checks.get_bin_variables(ds)

Get list of xarray.Dataset radar product variables with name starting with bin or ending with Bin.

In CMB products, bin variables end with the Bin suffix. In L1 and L2 RADAR products, bin variables starts with the bin prefix.

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

Get list of xarray.Dataset cross-section variables.

If strict=False (default), the potential variables for which a strict cross-section can be derived. If strict=True, the variables that are already a cross-section.

gpm.checks.get_frequency_dimension(xr_obj)

Return the name of the available frequency dimension.

gpm.checks.get_frequency_variables(ds)

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

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

Get list of xarray.Dataset 2D spatial variables.

If strict=False (default), the potential variables for which a 2D spatial field can be derived. If strict=True, the variables that are already a 2D spatial field.

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

Get list of xarray.Dataset 3D spatial variables.

If strict=False (default), the potential variables for which a 3D spatial field can be derived. If strict=True, the variables that are already a 3D spatial field.

gpm.checks.get_spatial_dimensions(xr_obj)

Return the name of the available spatial dimensions.

gpm.checks.get_vertical_dimension(xr_obj)

Return the name of the available vertical dimension.

gpm.checks.get_vertical_variables(ds)

Get list of xarray.Dataset variables with vertical dimension.

gpm.checks.has_frequency_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset have a frequency dimension.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True , the xarray.DataArray must have just the frequency dimension. If strict=False (default), the xarray.DataArray can also have additional dimensions.

gpm.checks.has_spatial_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset have a spatial dimension.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True , the xarray.DataArray can have only spatial dimensions. If strict=False (default), the xarray.DataArray can also have other dimensions.

gpm.checks.has_vertical_dim(xr_obj, strict=False, squeeze=True)

Check if the xarray.DataArray or xarray.Dataset have a vertical dimension.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True , the xarray.DataArray must have just the vertical dimension. If strict=False (default), the xarray.DataArray can also have additional dimensions.

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

Check if the xarray.DataArray or xarray.Dataset is a cross-section object.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True (default), the xarray.DataArray must have just the vertical dimension and a horizontal dimension. If strict=False , the xarray.DataArray can have additional dimensions but only a single horizontal and vertical dimension.

gpm.checks.is_grid(xr_obj)

Check whether the xarray object is a GPM GRID.

A GRID slice is not considered a GRID object ! An GRID object must have the coordinates available !

gpm.checks.is_orbit(xr_obj)

Check whether the xarray object is a GPM ORBIT.

An ORBIT cross-section (nadir view) or transect is considered ORBIT. An ORBIT object must have the coordinates available.

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

Check if the xarray.DataArray or xarray.Dataset is a spatial 2D object.

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

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

Check if the xarray.DataArray or xarray.Dataset i as spatial 3d object.

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

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

Check if the xarray.DataArray or xarray.Dataset is a transect object.

If squeeze=True (default), dimensions of size=1 are removed prior testing. If strict=True (default), the xarray.DataArray must have just an horizontal dimension. If strict=False , the xarray.DataArray can have additional dimensions but only a single horizontal dimension.

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_api.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_api.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 (str) – EarthData login password.

Module contents

GPM-API Package.