Index

_

_headings (Hydrological_model_validator.Report.report_utils.MyDocTemplate attribute)

A

add_efficiency_pages() (in module Hydrological_model_validator.Report.report_utils) add_heading() (Hydrological_model_validator.Report.report_utils.PDFReportBuilder method) add_multiple_images_grid() (in module Hydrological_model_validator.Report.report_utils) add_multiple_rotated_images_grid() (in module Hydrological_model_validator.Report.report_utils) add_plot_to_pdf() (in module Hydrological_model_validator.Report.report_utils) add_rotated_image_page() (in module Hydrological_model_validator.Report.report_utils)

add_seasonal_scatter_page() (in module Hydrological_model_validator.Report.report_utils) add_tables_page() (in module Hydrological_model_validator.Report.report_utils) afterFlowable() (Hydrological_model_validator.Report.report_utils.MyDocTemplate method) align_numpy_arrays() (in module Hydrological_model_validator.Processing.data_alignment) align_pandas_series() (in module Hydrological_model_validator.Processing.data_alignment) apply_3d_mask() (in module Hydrological_model_validator.Processing.data_alignment)

B

Benthic_chemical_plot() (in module Hydrological_model_validator.Plotting.bfm_plots) Benthic_depth() (in module Hydrological_model_validator.Plotting.bfm_plots) Benthic_physical_plot() (in module Hydrological_model_validator.Plotting.bfm_plots)

build_all_points() (in module Hydrological_model_validator.Processing.Taylor_computations) build_bfm_filename() (in module Hydrological_model_validator.Processing.utils) build_title_page() (Hydrological_model_validator.Report.report_utils.PDFReportBuilder method) build_toc() (Hydrological_model_validator.Report.report_utils.PDFReportBuilder method)

C

calc_density() (in module Hydrological_model_validator.Processing.Density) call_interpolator() (in module Hydrological_model_validator.Processing.file_io) check_missing_days() (in module Hydrological_model_validator.Processing.Missing_data) check_numeric_data() (in module Hydrological_model_validator.Processing.utils) comprehensive_target_diagram() (in module Hydrological_model_validator.Plotting.Target_plots) comprehensive_taylor_diagram() (in module Hydrological_model_validator.Plotting.Taylor_diagrams) compute_Bleast() (in module Hydrological_model_validator.Processing.Density) compute_Bmost() (in module Hydrological_model_validator.Processing.Density) compute_coverage_stats() (in module Hydrological_model_validator.Processing.stats_math_utils) compute_dense_water_volume() (in module Hydrological_model_validator.Processing.Density) compute_density_bottom() (in module Hydrological_model_validator.Processing.Density) compute_error_timeseries() (in module Hydrological_model_validator.Processing.Efficiency_metrics) compute_fft() (in module Hydrological_model_validator.Processing.stats_math_utils) compute_lagged_correlations() (in module Hydrological_model_validator.Processing.stats_math_utils) compute_norm_taylor_stats() (in module Hydrological_model_validator.Processing.Taylor_computations)

compute_normalised_target_stats() (in module Hydrological_model_validator.Processing.Target_computations) compute_normalised_target_stats_by_month() (in module Hydrological_model_validator.Processing.Target_computations) compute_single_month_target_stat() (in module Hydrological_model_validator.Processing.Target_computations) compute_single_target_stat() (in module Hydrological_model_validator.Processing.Target_computations) compute_spatial_efficiency() (in module Hydrological_model_validator.Processing.Efficiency_metrics) compute_stats_single_time() (in module Hydrological_model_validator.Processing.Efficiency_metrics) compute_std_reference() (in module Hydrological_model_validator.Processing.Taylor_computations) compute_target_extent_monthly() (in module Hydrological_model_validator.Processing.Target_computations) compute_target_extent_yearly() (in module Hydrological_model_validator.Processing.Target_computations) compute_taylor_stat_tuple() (in module Hydrological_model_validator.Processing.Taylor_computations) compute_yearly_taylor_stats() (in module Hydrological_model_validator.Processing.Taylor_computations) convert_dataarrays_in_df() (in module Hydrological_model_validator.Processing.utils) convert_to_serializable() (in module Hydrological_model_validator.Processing.Data_saver) corr_no_nan() (in module Hydrological_model_validator.Processing.stats_math_utils) cross_correlation() (in module Hydrological_model_validator.Processing.stats_math_utils) custom_offset_y (Hydrological_model_validator.Report.report_utils.RotatedImage attribute)

D

dense_water_timeseries() (in module Hydrological_model_validator.Plotting.bfm_plots) detrend_dim() (in module Hydrological_model_validator.Processing.stats_math_utils) detrend_linear() (in module Hydrological_model_validator.Processing.stats_math_utils) detrend_poly_dim() (in module Hydrological_model_validator.Processing.stats_math_utils)

detrended_monthly_anomaly() (in module Hydrological_model_validator.Processing.stats_math_utils) draw() (Hydrological_model_validator.Report.report_utils.PositionedTable method) (Hydrological_model_validator.Report.report_utils.RotatedImage method) draw_height (Hydrological_model_validator.Report.report_utils.RotatedImage attribute) draw_width (Hydrological_model_validator.Report.report_utils.RotatedImage attribute)

E

efficiency_plot() (in module Hydrological_model_validator.Plotting.Plots) eliminate_empty_fields() (in module Hydrological_model_validator.Processing.Missing_data) ensure_datetime_index() (in module Hydrological_model_validator.Processing.time_utils) error_components_timeseries() (in module Hydrological_model_validator.Plotting.Plots) extract_and_filter_benthic_data() (in module Hydrological_model_validator.Processing.BFM_data_reader)

extract_bottom_layer() (in module Hydrological_model_validator.Processing.BFM_data_reader) extract_mod_sat_keys() (in module Hydrological_model_validator.Processing.data_alignment) extract_multidecadal_peak() (in module Hydrological_model_validator.Processing.stats_math_utils) extract_multidecadal_peaks_from_spectra() (in module Hydrological_model_validator.Processing.stats_math_utils) extract_options() (in module Hydrological_model_validator.Processing.utils)

F

filter_dense_water_masses() (in module Hydrological_model_validator.Processing.Density) find_file_with_keywords() (in module Hydrological_model_validator.Processing.file_io) find_key() (in module Hydrological_model_validator.Processing.utils) find_key_variable() (in module Hydrological_model_validator.Processing.utils) find_missing_observations() (in module Hydrological_model_validator.Processing.Missing_data)

fit_huber() (in module Hydrological_model_validator.Processing.stats_math_utils) fit_lowess() (in module Hydrological_model_validator.Processing.stats_math_utils) flowable (Hydrological_model_validator.Report.report_utils.PositionedTable attribute) frame_height (Hydrological_model_validator.Report.report_utils.RotatedImage attribute) frame_width (Hydrological_model_validator.Report.report_utils.RotatedImage attribute)

G

gather_monthly_data_across_years() (in module Hydrological_model_validator.Processing.data_alignment) generate_full_report() (in module Hydrological_model_validator.Report_generator) get_common_series_by_year() (in module Hydrological_model_validator.Processing.data_alignment) get_common_series_by_year_month() (in module Hydrological_model_validator.Processing.data_alignment)

get_common_years() (in module Hydrological_model_validator.Processing.time_utils) get_season_mask() (in module Hydrological_model_validator.Processing.time_utils) get_valid_mask() (in module Hydrological_model_validator.Processing.data_alignment) get_valid_mask_pandas() (in module Hydrological_model_validator.Processing.data_alignment)

H

hal_threshold() (in module Hydrological_model_validator.Processing.utils) header_height (Hydrological_model_validator.Report.report_utils.RotatedImage attribute) Hydrological_model_validator.Plotting.bfm_plots module Hydrological_model_validator.Plotting.Plots module Hydrological_model_validator.Plotting.Target_plots module Hydrological_model_validator.Plotting.Taylor_diagrams module Hydrological_model_validator.Processing.BFM_data_reader module Hydrological_model_validator.Processing.data_alignment module Hydrological_model_validator.Processing.Data_saver module Hydrological_model_validator.Processing.Density module Hydrological_model_validator.Processing.Efficiency_metrics module Hydrological_model_validator.Processing.file_io module

Hydrological_model_validator.Processing.Missing_data module Hydrological_model_validator.Processing.MOD_data_reader module Hydrological_model_validator.Processing.SAT_data_reader module Hydrological_model_validator.Processing.stats_math_utils module Hydrological_model_validator.Processing.Target_computations module Hydrological_model_validator.Processing.Taylor_computations module Hydrological_model_validator.Processing.time_utils module Hydrological_model_validator.Processing.utils module Hydrological_model_validator.Report.report_utils module Hydrological_model_validator.Report_generator module

I

identify_extreme_events() (in module Hydrological_model_validator.Processing.stats_math_utils) img_path (Hydrological_model_validator.Report.report_utils.RotatedImage attribute) index_of_agreement() (in module Hydrological_model_validator.Processing.Efficiency_metrics)

index_of_agreement_j() (in module Hydrological_model_validator.Processing.Efficiency_metrics) infer_years_from_path() (in module Hydrological_model_validator.Processing.utils) is_invalid_time_index() (in module Hydrological_model_validator.Processing.time_utils)

L

leapyear() (in module Hydrological_model_validator.Processing.time_utils)

ln_nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) load_dataset() (in module Hydrological_model_validator.Processing.file_io)

M

margin (Hydrological_model_validator.Report.report_utils.RotatedImage attribute) mask_reader() (in module Hydrological_model_validator.Processing.file_io) mean_bias() (in module Hydrological_model_validator.Processing.stats_math_utils) module Hydrological_model_validator.Plotting.bfm_plots Hydrological_model_validator.Plotting.Plots Hydrological_model_validator.Plotting.Target_plots Hydrological_model_validator.Plotting.Taylor_diagrams Hydrological_model_validator.Processing.BFM_data_reader Hydrological_model_validator.Processing.data_alignment Hydrological_model_validator.Processing.Data_saver Hydrological_model_validator.Processing.Density Hydrological_model_validator.Processing.Efficiency_metrics Hydrological_model_validator.Processing.file_io Hydrological_model_validator.Processing.Missing_data Hydrological_model_validator.Processing.MOD_data_reader Hydrological_model_validator.Processing.SAT_data_reader Hydrological_model_validator.Processing.stats_math_utils Hydrological_model_validator.Processing.Target_computations Hydrological_model_validator.Processing.Taylor_computations Hydrological_model_validator.Processing.time_utils Hydrological_model_validator.Processing.utils Hydrological_model_validator.Report.report_utils Hydrological_model_validator.Report_generator

monthly_anomaly() (in module Hydrological_model_validator.Processing.stats_math_utils) monthly_index_of_agreement() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_index_of_agreement_j() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_ln_nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_nse_j() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_r_squared() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_relative_index_of_agreement() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_relative_nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) monthly_taylor_diagram() (in module Hydrological_model_validator.Plotting.Taylor_diagrams) monthly_weighted_r_squared() (in module Hydrological_model_validator.Processing.Efficiency_metrics) MyDocTemplate (class in Hydrological_model_validator.Report.report_utils)

N

np_correlation() (in module Hydrological_model_validator.Processing.stats_math_utils) np_covariance() (in module Hydrological_model_validator.Processing.stats_math_utils)

np_regression() (in module Hydrological_model_validator.Processing.stats_math_utils) nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) nse_j() (in module Hydrological_model_validator.Processing.Efficiency_metrics)

O

orig_height (Hydrological_model_validator.Report.report_utils.RotatedImage attribute)

orig_width (Hydrological_model_validator.Report.report_utils.RotatedImage attribute)

P

pdf_path (Hydrological_model_validator.Report.report_utils.PDFReportBuilder attribute) PDFReportBuilder (class in Hydrological_model_validator.Report.report_utils) plot_benthic_3d_mesh() (in module Hydrological_model_validator.Plotting.bfm_plots) plot_spatial_efficiency() (in module Hydrological_model_validator.Plotting.Plots)

plot_spectral() (in module Hydrological_model_validator.Plotting.Plots) PositionedTable (class in Hydrological_model_validator.Report.report_utils) process_year() (in module Hydrological_model_validator.Processing.BFM_data_reader) prompt_for_datetime_index() (in module Hydrological_model_validator.Processing.time_utils)

R

r_squared() (in module Hydrological_model_validator.Processing.Efficiency_metrics) read_benthic_parameter() (in module Hydrological_model_validator.Processing.BFM_data_reader) read_bfm_chemical() (in module Hydrological_model_validator.Processing.BFM_data_reader) read_model_data() (in module Hydrological_model_validator.Processing.MOD_data_reader) read_nc_variable_from_gz_in_memory() (in module Hydrological_model_validator.Processing.file_io)

read_nc_variable_from_unzipped_file() (in module Hydrological_model_validator.Processing.file_io) relative_index_of_agreement() (in module Hydrological_model_validator.Processing.Efficiency_metrics) relative_nse() (in module Hydrological_model_validator.Processing.Efficiency_metrics) resample_and_compute() (in module Hydrological_model_validator.Processing.time_utils) RotatedImage (class in Hydrological_model_validator.Report.report_utils) round_up_to_nearest() (in module Hydrological_model_validator.Processing.stats_math_utils)

S

sat_data_loader() (in module Hydrological_model_validator.Processing.SAT_data_reader) save() (Hydrological_model_validator.Report.report_utils.PDFReportBuilder method) save_model_data() (in module Hydrological_model_validator.Processing.Data_saver) save_satellite_data() (in module Hydrological_model_validator.Processing.Data_saver) save_to_netcdf() (in module Hydrological_model_validator.Processing.Data_saver) save_variable_to_json() (in module Hydrological_model_validator.Processing.Data_saver) scatter_plot() (in module Hydrological_model_validator.Plotting.Plots) seasonal_scatter_plot() (in module Hydrological_model_validator.Plotting.Plots)

select_3d_variable() (in module Hydrological_model_validator.Processing.file_io) spatial_mean() (in module Hydrological_model_validator.Processing.stats_math_utils) split_to_monthly() (in module Hydrological_model_validator.Processing.time_utils) split_to_yearly() (in module Hydrological_model_validator.Processing.time_utils) standard_deviation_error() (in module Hydrological_model_validator.Processing.stats_math_utils) std_dev() (in module Hydrological_model_validator.Processing.stats_math_utils) story (Hydrological_model_validator.Report.report_utils.PDFReportBuilder attribute) styles (Hydrological_model_validator.Report.report_utils.PDFReportBuilder attribute)

T

target_diagram_by_month() (in module Hydrological_model_validator.Plotting.Target_plots) temp_threshold() (in module Hydrological_model_validator.Processing.utils) Timer() (in module Hydrological_model_validator.Processing.time_utils)

timeseries() (in module Hydrological_model_validator.Plotting.Plots) toc (Hydrological_model_validator.Report.report_utils.PDFReportBuilder attribute) true_time_series_length() (in module Hydrological_model_validator.Processing.time_utils)

U

unbiased_rmse() (in module Hydrological_model_validator.Processing.stats_math_utils)

unzip_gz_to_file() (in module Hydrological_model_validator.Processing.file_io)

V

violinplot() (in module Hydrological_model_validator.Plotting.Plots)

W

weighted_r_squared() (in module Hydrological_model_validator.Processing.Efficiency_metrics) whiskerbox() (in module Hydrological_model_validator.Plotting.Plots)

wrap() (Hydrological_model_validator.Report.report_utils.PositionedTable method) (Hydrological_model_validator.Report.report_utils.RotatedImage method)

X

x_offset (Hydrological_model_validator.Report.report_utils.PositionedTable attribute)

Y

y_offset (Hydrological_model_validator.Report.report_utils.PositionedTable attribute)

yearly_anomaly() (in module Hydrological_model_validator.Processing.stats_math_utils)