disdrodb package

Subpackages

• disdrodb.l0 package
  • Subpackages
    • disdrodb.l0.readers package
      • Submodules
      • disdrodb.l0.readers.reader_template module
      • Module contents
  • Submodules
  • disdrodb.l0.l0a_processing module
    • cast_column_dtypes()
    • coerce_corrupted_values_to_nan()
    • concatenate_dataframe()
    • drop_time_periods()
    • drop_timesteps()
    • preprocess_reader_kwargs()
    • process_raw_file()
    • read_raw_data()
    • read_raw_file_list()
    • remove_corrupted_rows()
    • remove_duplicated_timesteps()
    • remove_issue_timesteps()
    • remove_rows_with_missing_time()
    • replace_nan_flags()
    • set_nan_outside_data_range()
    • set_nan_unvalid_values()
    • strip_delimiter_from_raw_arrays()
    • strip_string_spaces()
    • write_l0a()
  • disdrodb.l0.l0b_processing module
    • add_dataset_crs_coords()
    • add_dataset_missing_variables()
    • convert_object_variables_to_string()
    • create_l0b_from_l0a()
    • format_string_array()
    • get_bin_coords()
    • infer_split_str()
    • preprocess_raw_netcdf()
    • process_raw_nc()
    • rechunk_dataset()
    • rename_dataset()
    • replace_custom_nan_flags()
    • replace_nan_flags()
    • reshape_raw_spectrum()
    • retrieve_l0b_arrays()
    • sanitize_encodings_dict()
    • set_coordinate_attributes()
    • set_dataset_attrs()
    • set_encodings()
    • set_nan_outside_data_range()
    • set_nan_unvalid_values()
    • set_variable_attributes()
    • subset_dataset()
    • write_l0b()
  • disdrodb.l0.l0b_concat module
    • run_disdrodb_l0b_concat()
    • run_disdrodb_l0b_concat_station()
  • disdrodb.l0.l0_processing module
    • click_l0_archive_options()
    • click_l0_processing_options()
    • click_l0_station_arguments()
    • click_l0_stations_options()
    • click_l0b_concat_options()
    • run_disdrodb_l0()
    • run_disdrodb_l0_station()
    • run_disdrodb_l0a()
    • run_disdrodb_l0a_station()
    • run_disdrodb_l0b()
    • run_disdrodb_l0b_station()
    • run_l0a()
    • run_l0b()
    • run_l0b_from_nc()
  • disdrodb.l0.l0_reader module
    • available_readers()
    • check_available_readers()
    • check_reader_arguments()
    • check_reader_exists()
    • get_available_readers_dict()
    • get_reader()
    • get_reader_from_metadata_reader_key()
    • get_station_reader()
    • is_documented_by()
    • reader_generic_docstring()
  • disdrodb.l0.check_configs module
    • check_bin_consistency()
    • check_sensor_configs()
    • check_variable_keys_consistency()
  • disdrodb.l0.check_metadata module
    • check_archive_metadata_campaign_name()
    • check_archive_metadata_compliance()
    • check_archive_metadata_data_source()
    • check_archive_metadata_geolocation()
    • check_archive_metadata_keys()
    • check_archive_metadata_reader()
    • check_archive_metadata_sensor_name()
    • check_archive_metadata_station_name()
    • check_metadata_geolocation()
    • get_archive_metadata_key_value()
    • identify_empty_metadata_keys()
    • identify_missing_metadata_coords()
    • read_yaml()
  • disdrodb.l0.check_standards module
    • check_l0a_column_names()
    • check_l0a_standards()
    • check_l0b_standards()
    • check_sensor_name()
  • disdrodb.l0.io module
    • check_glob_pattern()
    • check_glob_patterns()
    • check_processed_dir()
    • check_raw_dir()
    • create_directory_structure()
    • create_initial_directory_structure()
    • get_L0A_dir()
    • get_L0A_fname()
    • get_L0A_fpath()
    • get_L0B_dir()
    • get_L0B_fname()
    • get_L0B_fpath()
    • get_campaign_name()
    • get_data_source()
    • get_dataframe_min_max_time()
    • get_dataset_min_max_time()
    • get_disdrodb_dir()
    • get_disdrodb_path()
    • get_l0a_file_list()
    • get_raw_file_list()
    • read_L0A_dataframe()
  • disdrodb.l0.issue module
    • NoDatesSafeLoader
      • NoDatesSafeLoader.remove_implicit_resolver()
    • check_issue_dict()
    • check_issue_file()
    • check_time_periods()
    • check_timesteps()
    • is_numpy_array_datetime()
    • is_numpy_array_string()
    • load_yaml_without_date_parsing()
    • read_issue()
    • read_issue_file()
    • write_default_issue()
    • write_issue_dict()
  • disdrodb.l0.metadata module
    • add_missing_metadata_keys()
    • check_metadata_compliance()
    • create_campaign_default_metadata()
    • get_default_metadata_dict()
    • get_metadata_missing_keys()
    • get_metadata_unvalid_keys()
    • get_valid_metadata_keys()
    • read_metadata()
    • remove_unvalid_metadata_keys()
    • sort_metadata_dictionary()
    • write_default_metadata()
    • write_metadata()
  • disdrodb.l0.standards module
    • available_sensor_name()
    • get_L0A_encodings_dict()
    • get_L0B_encodings_dict()
    • get_configs_dir()
    • get_coords_attrs_dict()
    • get_data_format_dict()
    • get_data_range_dict()
    • get_description_dict()
    • get_diameter_bin_center()
    • get_diameter_bin_lower()
    • get_diameter_bin_upper()
    • get_diameter_bin_width()
    • get_diameter_bins_dict()
    • get_dims_size_dict()
    • get_field_nchar_dict()
    • get_field_ndigits_decimals_dict()
    • get_field_ndigits_dict()
    • get_field_ndigits_natural_dict()
    • get_l0a_dtype()
    • get_long_name_dict()
    • get_n_diameter_bins()
    • get_n_velocity_bins()
    • get_nan_flags_dict()
    • get_raw_array_dims_order()
    • get_raw_array_nvalues()
    • get_sensor_variables()
    • get_time_encoding()
    • get_units_dict()
    • get_valid_coordinates_names()
    • get_valid_dimension_names()
    • get_valid_names()
    • get_valid_values_dict()
    • get_valid_variable_names()
    • get_variables_dict()
    • get_variables_dimension()
    • get_velocity_bin_center()
    • get_velocity_bin_lower()
    • get_velocity_bin_upper()
    • get_velocity_bin_width()
    • get_velocity_bins_dict()
    • read_config_yml()
    • set_disdrodb_attrs()
  • disdrodb.l0.summary module
  • disdrodb.l0.template_tools module
    • arr_has_constant_nchar()
    • check_column_names()
    • get_decimal_ndigits()
    • get_df_columns_unique_values_dict()
    • get_natural_ndigits()
    • get_nchar()
    • get_ndigits()
    • get_possible_keys()
    • infer_column_names()
    • print_df_column_names()
    • print_df_columns_unique_values()
    • print_df_first_n_rows()
    • print_df_random_n_rows()
    • print_df_summary_stats()
    • print_df_with_any_nan_rows()
    • print_valid_L0_column_names()
    • search_possible_columns()
    • str_has_decimal_digits()
    • str_is_integer()
    • str_is_not_number()
    • str_is_number()
  • Module contents
    • available_readers()
    • check_archive_metadata_compliance()
    • check_archive_metadata_geolocation()
    • run_disdrodb_l0()
    • run_disdrodb_l0_station()
    • run_l0a()
    • run_l0b_from_nc()
• disdrodb.l1 package
  • Submodules
  • disdrodb.l1.utils module
    • regularize_dataset()
  • Module contents
• disdrodb.l2 package
  • Module contents
• disdrodb.api package
  • Module contents
• disdrodb.utils package
  • Submodules
  • disdrodb.utils.logger module
    • close_logger()
    • create_file_logger()
    • create_l0_logger()
    • define_summary_log()
    • log_debug()
    • log_error()
    • log_info()
    • log_warning()
  • disdrodb.utils.netcdf module
    • ensure_monotonic_dimension()
    • ensure_unique_dimension_values()
    • get_list_ds()
    • xr_concat_datasets()
  • disdrodb.utils.scripts module
    • parse_arg_to_list()
  • Module contents

Module contents

disdrodb.available_campaigns(disdrodb_dir, product_level, data_sources=None, return_tuple=True)

Return campaigns for which stations data are available.

disdrodb.available_data_sources(disdrodb_dir, product_level)

Return data sources for which stations data are available.

disdrodb.available_sensor_name() → sorted

Get available names of sensors.

Returns:

Sorted list of the available sensors

Return type:

sorted

disdrodb.available_stations(disdrodb_dir, product_level, data_sources=None, campaign_names=None, return_tuple=True)

Return stations for which data are available.

disdrodb.read_station_metadata(disdrodb_dir, product_level, data_source, campaign_name, station_name)

Open the station metadata YAML file into a dictionary.