2. API

2.1. Subpackages

• 2.1.1. rainfallqc.checks package
  • 2.1.1.1. Submodules
  • 2.1.1.2. rainfallqc.checks.comparison_checks module
    • add_daily_year_col()
    • check_annual_exceedance_etccdi_prcptot()
    • check_annual_exceedance_etccdi_r99p()
    • check_exceedance_of_rainfall_world_record()
    • check_hourly_exceedance_etccdi_rx1day()
    • flag_exceedance_of_max_etccdi_variable()
    • flag_exceedance_of_ref_val()
    • flag_exceedance_of_ref_val_as_col()
    • get_sum_rainfall_above_percentile_per_year()
  • 2.1.1.3. rainfallqc.checks.gauge_checks module
    • check_breakpoints()
    • check_intermittency()
    • check_min_val_change()
    • check_temporal_bias()
    • check_years_where_annual_mean_k_top_rows_are_zero()
    • check_years_where_nth_percentile_is_zero()
  • 2.1.1.4. rainfallqc.checks.neighbourhood_checks module
    • add_wet_flags_to_data()
    • check_daily_factor()
    • check_dry_neighbours()
    • check_monthly_factor()
    • check_monthly_neighbours()
    • check_nearest_neighbour_columns()
    • check_neighbour_affinity_index()
    • check_neighbour_correlation()
    • check_timing_offset()
    • check_wet_neighbours()
    • filter_data_based_on_unusual_wetness()
    • flag_dry_spell_fractions()
    • flag_monthly_factor_differences()
    • flag_percentage_diff_of_neighbour()
    • flag_wet_day_errors_based_on_neighbours()
    • get_dry_spell_fraction_col()
    • get_majority_positive_or_negative_flags()
    • get_majority_voting_flag()
    • make_neighbour_monthly_max_climatology()
    • make_num_neighbours_online_col()
    • normalised_diff_between_target_neighbours()
    • upgrade_monthly_flag_using_neighbour_max_climatology()
  • 2.1.1.5. rainfallqc.checks.timeseries_checks module
    • check_daily_accumulations()
    • check_dry_period_cdd()
    • check_monthly_accumulations()
    • check_streaks()
    • compute_dry_spell_days()
    • fill_in_monthly_accumulation_flags()
    • flag_accumulation_based_on_next_dry_spell_duration()
    • flag_accumulation_periods()
    • flag_dry_spell_duration()
    • flag_n_hours_accumulation_based_on_threshold()
    • flag_streaks_exceeding_smallest_measurable_rainfall_amount()
    • flag_streaks_exceeding_wet_day_rainfall_threshold()
    • flag_streaks_exceeding_zero()
    • flag_streaks_of_zero_bounded_by_days()
    • get_accumulation_threshold()
    • get_accumulation_threshold_from_etccdi()
    • get_consecutive_dry_days()
    • get_daily_non_wr_data()
    • get_dry_spell_duration()
    • get_dry_spell_info()
    • get_first_wet_after_dry_spell()
    • get_local_etccdi_sdii_mean()
    • get_possible_accumulations()
    • get_streaks_above_threshold()
    • get_streaks_of_repeated_values()
    • get_surrounding_dry_spell_lengths()
    • join_dry_spell_data_back_to_original()
  • 2.1.1.6. rainfallqc.checks.pypwsqc_filters module
    • check_faulty_zeros()
    • check_high_influx_filter()
    • check_station_outlier()
    • compute_distance_matrix()
    • convert_neighbour_data_to_xarray()
    • run_bias_correction()
    • run_event_based_filter()
    • run_indicator_correlation()
    • run_peak_removal()
    • subset_distance_matrix()
  • 2.1.1.7. Module contents
• 2.1.2. rainfallqc.qc_frameworks package
  • 2.1.2.1. Submodules
  • 2.1.2.2. rainfallqc.qc_frameworks.apply_qc_framework module
    • run_qc_framework()
  • 2.1.2.3. rainfallqc.qc_frameworks.inbuilt_qc_frameworks module
    • get_qc_name_from_qc_key()
  • 2.1.2.4. Module contents
• 2.1.3. rainfallqc.utils package
  • 2.1.3.1. Submodules
  • 2.1.3.2. rainfallqc.utils.data_readers module
    • GPCCNetworkReader
      • GPCCNetworkReader.load_network_data()
    • GSDRNetworkReader
      • GSDRNetworkReader.load_network_data()
    • GaugeNetworkReader
      • GaugeNetworkReader.get_nearest_overlapping_neighbours_to_target()
    • add_datetime_to_gsdr_data()
    • convert_gsdr_metadata_dates_to_datetime()
    • get_paths_using_gauge_ids()
    • load_etccdi_data()
    • load_gpcc_gauge_network_metadata()
    • load_gsdr_gauge_network_metadata()
    • read_gpcc_data_from_zip()
    • read_gpcc_metadata_from_zip()
    • read_gsdr_data_from_file()
    • read_gsdr_metadata()
  • 2.1.3.3. rainfallqc.utils.data_utils module
    • back_propagate_daily_data_flags()
    • calculate_dry_spell_fraction()
    • check_data_has_consistent_time_step()
    • check_data_is_monthly()
    • check_data_is_specific_time_res()
    • check_for_negative_values()
    • convert_daily_data_to_monthly()
    • convert_datarray_seconds_to_days()
    • downsample_and_fill_columns()
    • downsample_monthly_data()
    • extract_negative_values_from_data()
    • extract_positive_values_from_data()
    • format_timedelta_duration()
    • get_data_timestep_as_str()
    • get_data_timesteps()
    • get_dry_period_proportions()
    • get_dry_spells()
    • get_expected_days_in_month()
    • get_normalised_diff()
    • make_month_and_year_col()
    • normalise_data()
    • offset_data_by_time()
    • replace_missing_vals_with_nan()
    • resample_data_by_time_step()
  • 2.1.3.4. rainfallqc.utils.neighbourhood_utils module
    • compute_km_distances_from_target_id()
    • compute_temporal_overlap_days()
    • compute_temporal_overlap_days_from_target_id()
    • get_ids_of_n_nearest_overlapping_neighbouring_gauges()
    • get_n_closest_neighbours()
    • get_nearest_non_nan_etccdi_val_to_gauge()
    • get_neighbours_with_min_overlap_days()
    • get_rain_not_minima_column()
    • get_target_neighbour_non_zero_minima()
    • make_rain_not_minima_column_target_or_neighbour()
  • 2.1.3.5. rainfallqc.utils.spatial_utils module
    • compute_spatial_mean_xr()
    • haversine()
  • 2.1.3.6. rainfallqc.utils.stats module
    • affinity_index()
    • dry_spell_fraction()
    • factor_diff()
    • filter_out_rain_world_records()
    • fit_expon_and_get_percentile()
    • gauge_correlation()
    • get_rainfall_world_records()
    • percentage_diff()
    • pettitt_test()
    • simple_precip_intensity_index()
  • 2.1.3.7. Module contents

2.2. Module contents

Top-level package for RainfallQC.