Skip to content

API Reference

Salvador Navas edited this page Aug 4, 2026 · 3 revisions

API Reference

This page summarizes the main public entry points. For exact signatures, inspect the source modules and tests.

pyhydra.data

  • download_pilot_case
  • list_pilot_cases

pyhydra.data_sources.rainfall

  • GPMDownloader
  • download_era5
  • PERSSIANDownloader
  • download_aemet_daily_data
  • AEMETDownloader
  • AemetCSVLoader
  • fetch_station_inventory
  • OGIMETDownloader
  • OgimetCSVLoader
  • download_synop
  • get_default_ogimet_stations_csv
  • process_all_meteorological_variables
  • MeteostatDownloader
  • MeteostatCSVLoader
  • get_meteostat_stations_nearby
  • download_meteostat_series
  • score_meteostat_stations
  • select_best_meteostat_station
  • download_best_meteostat_series
  • find_station_by_wmo

pyhydra.data_sources.river_discharge

  • read_grdc
  • read_grdc_metadata
  • read_grdc_folder
  • analyze_grdc_quality
  • download_usgs
  • get_usgs_site_info
  • search_usgs_sites
  • download_glofas
  • download_glofas_by_year
  • read_glofas_nc

pyhydra.data_sources.climate_change

  • download_CDS_CMIP6
  • get_dataset_metadata
  • get_all_urls
  • get_combination_if_complete
  • download_file
  • process_file

pyhydra.data_sources.soils

  • download_soilgrids
  • open_soilgrids_geotif
  • find_usda_soilclass
  • create_new_tif
  • convert_depth_to_soilclass
  • extract_mode_soilclass

pyhydra.climate.time_series

  • extract_events
  • extract_discharge_events
  • extract_precipitation_events
  • extract_precipitation_events_pot
  • extract_precipitation_events_nday
  • extract_concurrent_events
  • extract_block_maxima
  • extract_pot
  • threshold_stability_plot
  • fit_gev
  • fit_gev_map
  • fit_gev_fisher
  • fit_gev_mcmc
  • fit_gpd
  • return_level_gev
  • return_level_gpd
  • return_levels
  • return_level_ci
  • plot_return_levels
  • plot_diagnostic
  • compute_nse
  • compute_kge
  • compute_pbias

pyhydra.climate.bias_correction

  • BiasCorrection
  • delta_method

pyhydra.climate.spatial_analysis

  • FloodEventCopula
  • GaussianCopulaSampler
  • fit_marginal
  • fit_discrete_marginal
  • BivariateCopula
  • TrivariateCopula
  • VineCopula
  • fit_gev_mle
  • fit_gev_lmom
  • fit_gev_bayes
  • return_level
  • return_level_bayes
  • regional_index_flood
  • fit_regional_gev
  • regional_return_levels
  • regional_discordancy
  • discordancy_critical_value
  • regional_heterogeneity
  • IDWInterpolator
  • KrigingInterpolator
  • GaussianProcessInterpolator
  • NeopreneGPReconstructor
  • CopulaCDFEmulator
  • HierarchicalGEV

pyhydra.climate.stochastic_generation

  • NSRPModel
  • analyze_ts
  • report_ts
  • simulate_ts
  • generate_ts
  • fit_distribution
  • fit_acs
  • STNSRPModel
  • SpatialFieldModel
  • fit_spatial_model
  • generate_random_field
  • generate_random_field_fast
  • check_random_field

pyhydra.climate.hybrid_downscaling

  • HydrographClassifier
  • find_spatial_arrangement
  • HydrographReconstructor
  • maxdiss
  • FloodMapInterpolator
  • FloodMapInterpolatorCC
  • pixel_return_period
  • save_return_period_geotiffs
  • DEFAULT_RETURN_PERIODS
  • FloodEventSelector
  • FloodCopulaComparison

pyhydra.modeling.hydrology

  • read_gages
  • read_met
  • read_basin
  • read_subbasin
  • read_control
  • read_run
  • generate_gage
  • fill_gage
  • generate_met
  • generate_met_freq_storm
  • generate_hms
  • generate_control
  • generate_run
  • generate_py
  • generate_flow
  • run_hms_script
  • HMSModel
  • extract_curve_number
  • calculate_clark_parameters
  • estimate_muskingum_k
  • update_basin_file
  • run_climate_change_scenarios
  • write_precipitation_file
  • write_temperature_file
  • write_swatplus_precipitation_files
  • write_swatplus_temperature_files
  • edit_file_cio
  • run_swat
  • read_channel_sd
  • read_swat_discharge

pyhydra.modeling.hydraulic

  • modify_unsteady_file
  • modify_plan_file
  • modify_project_file
  • create_flow_series
  • run_hec_ras
  • read_ras_dss_timeseries
  • read_ras_max_wsel
  • setup_sfincs_model
  • run_sfincs
  • generate_manning_combinations
  • generate_manning_combinations_correlated
  • load_flood_ensemble
  • load_sfincs_ensemble
  • build_manning_ensemble
  • compute_manning_stats
  • flooded_area
  • spatial_stats
  • manning_flood_regression
  • filter_anomalous_simulations

pyhydra.uq

  • maxdiss_order
  • pilot_design
  • voronoi_weights
  • standardize
  • emulability
  • Emulability
  • SELECTION_CAP
  • emulator_families
  • DEFAULT_FAMILIES
  • RBF
  • RBF_SMOOTHING
  • EnsembleMean
  • PeakOnly1D
  • select_strategy
  • propagate
  • reduce_and_emulate
  • StrategyDecision
  • PropagationResult
  • EMULABILITY_THRESHOLD
  • sequential_design
  • loo_error
  • StoppingResult
  • error_metrics
  • weighted_rmse
  • weighted_r2

Clone this wiki locally