Skip to main content
Ctrl+K
nwm_region_mgr
0.1.0
  • User Guide
  • FAQ
  • Configuration
  • Technical Reference
  • API
  • User Guide
  • FAQ
  • Configuration
  • Technical Reference
  • API

Section Navigation

  • nwm_region_mgr.formreg
    • nwm_region_mgr.formreg.config_schema
      • nwm_region_mgr.formreg.config_schema.BestFormulation
      • nwm_region_mgr.formreg.config_schema.Config
      • nwm_region_mgr.formreg.config_schema.FormulationCostConfig
      • nwm_region_mgr.formreg.config_schema.FormulationGeneralSettings
      • nwm_region_mgr.formreg.config_schema.FormulationOutputConfig
      • nwm_region_mgr.formreg.config_schema.FormulationSpatialUnitConfig
      • nwm_region_mgr.formreg.config_schema.FormulationSummaryScoreConfig
      • nwm_region_mgr.formreg.config_schema.MetricConfig
      • nwm_region_mgr.formreg.config_schema.MetricEvalPeriod
      • nwm_region_mgr.formreg.config_schema.Orientation
    • nwm_region_mgr.formreg.process_config
      • nwm_region_mgr.formreg.process_config.FormulationRegionalizationProcessor
    • nwm_region_mgr.formreg.select_formulation
      • nwm_region_mgr.formreg.select_formulation.check_gage_formulation_uniqueness
      • nwm_region_mgr.formreg.select_formulation.plot_formulation_results
      • nwm_region_mgr.formreg.select_formulation.save_formulation_results
      • nwm_region_mgr.formreg.select_formulation.select_formulation
      • nwm_region_mgr.formreg.select_formulation.select_formulation_all
      • nwm_region_mgr.formreg.select_formulation.select_formulation_donors_only
    • nwm_region_mgr.formreg.summary_score
      • nwm_region_mgr.formreg.summary_score.compute_summary_score
      • nwm_region_mgr.formreg.summary_score.formulation_summary_score
      • nwm_region_mgr.formreg.summary_score.get_formulations_from_stats
  • nwm_region_mgr.parreg
    • nwm_region_mgr.parreg.config_schema
      • nwm_region_mgr.parreg.config_schema.AlgoGeneral
      • nwm_region_mgr.parreg.config_schema.AlgorithmConfig
      • nwm_region_mgr.parreg.config_schema.AttrDatasetConfig
      • nwm_region_mgr.parreg.config_schema.AvailableAttrsConfig
      • nwm_region_mgr.parreg.config_schema.Birch
      • nwm_region_mgr.parreg.config_schema.Config
      • nwm_region_mgr.parreg.config_schema.DonorConfig
      • nwm_region_mgr.parreg.config_schema.GeneralConfig
      • nwm_region_mgr.parreg.config_schema.Gower
      • nwm_region_mgr.parreg.config_schema.HDBSCAN
      • nwm_region_mgr.parreg.config_schema.KMeans
      • nwm_region_mgr.parreg.config_schema.KMedoids
      • nwm_region_mgr.parreg.config_schema.MetricEvalPeriod
      • nwm_region_mgr.parreg.config_schema.MetricThreshold
      • nwm_region_mgr.parreg.config_schema.ParameterOutputConfig
      • nwm_region_mgr.parreg.config_schema.SnowCoverConfig
      • nwm_region_mgr.parreg.config_schema.URF
    • nwm_region_mgr.parreg.logging_config
      • nwm_region_mgr.parreg.logging_config.setup_logging
    • nwm_region_mgr.parreg.pairer
      • nwm_region_mgr.parreg.pairer.Pairer
    • nwm_region_mgr.parreg.plot_outputs
      • nwm_region_mgr.parreg.plot_outputs.plot_donor_spatial_map
      • nwm_region_mgr.parreg.plot_outputs.plot_missing_attr_counts
    • nwm_region_mgr.parreg.synthetic_data
      • nwm_region_mgr.parreg.synthetic_data.create_synthetic_data
      • nwm_region_mgr.parreg.synthetic_data.default_synthetic_data
      • nwm_region_mgr.parreg.synthetic_data.f_synthetic_data
  • nwm_region_mgr.utils
    • nwm_region_mgr.utils.config_utils
      • nwm_region_mgr.utils.config_utils.BaseConfig
      • nwm_region_mgr.utils.config_utils.BaseConfigProcessor
      • nwm_region_mgr.utils.config_utils.BaseGeneralConfig
      • nwm_region_mgr.utils.config_utils.BaseOutputConfig
      • nwm_region_mgr.utils.config_utils.FieldCrosswalk
      • nwm_region_mgr.utils.config_utils.LayerCrosswalk
      • nwm_region_mgr.utils.config_utils.LoggingConfig
      • nwm_region_mgr.utils.config_utils.PydanticDictLike
    • nwm_region_mgr.utils.dict_utils
      • nwm_region_mgr.utils.dict_utils.convert_enum_to_value
      • nwm_region_mgr.utils.dict_utils.flatten_dict
      • nwm_region_mgr.utils.dict_utils.remove_nulls
    • nwm_region_mgr.utils.hydrofabric_utils
      • nwm_region_mgr.utils.hydrofabric_utils.area_weighted_average
      • nwm_region_mgr.utils.hydrofabric_utils.find_gages_within_buffer
    • nwm_region_mgr.utils.io_utils
      • nwm_region_mgr.utils.io_utils.read_table
      • nwm_region_mgr.utils.io_utils.read_table_safely
      • nwm_region_mgr.utils.io_utils.save_data
    • nwm_region_mgr.utils.logging_utils
      • nwm_region_mgr.utils.logging_utils.CustomLoggingFormatter
      • nwm_region_mgr.utils.logging_utils.setup_logging
    • nwm_region_mgr.utils.plot_utils
      • nwm_region_mgr.utils.plot_utils.plot_histogram
      • nwm_region_mgr.utils.plot_utils.plot_point_map
      • nwm_region_mgr.utils.plot_utils.plot_spatial_map
    • nwm_region_mgr.utils.string_utils
      • nwm_region_mgr.utils.string_utils.expand_with_lists
      • nwm_region_mgr.utils.string_utils.recursive_substitute
      • nwm_region_mgr.utils.string_utils.recursive_substitute_multi_lists
    • nwm_region_mgr.utils.validation_utils
      • nwm_region_mgr.utils.validation_utils.check_columns_dataframe
      • nwm_region_mgr.utils.validation_utils.check_columns_hydrofabric
      • nwm_region_mgr.utils.validation_utils.check_options
  • nwm_region_mgr.ngen
    • nwm_region_mgr.ngen.config_schema
      • nwm_region_mgr.ngen.config_schema.Config
      • nwm_region_mgr.ngen.config_schema.NgenGeneralSettings
      • nwm_region_mgr.ngen.config_schema.NgenOutputConfig
      • nwm_region_mgr.ngen.config_schema.validate_timestamp
  • API Reference

API Reference#

nwm_region_mgr.formreg

formreg package with classes and functions for Formulation Regionalization.

nwm_region_mgr.parreg

parreg package with classes and functions for Parameter Regionalization.

nwm_region_mgr.utils

utils package with various utility/helper functions.

nwm_region_mgr.ngen

ngen package with classes and functions for running NGEN simulation for regionalization.

previous

Output Directory Structure

next

nwm_region_mgr.formreg

This Page

  • Show Source

© Copyright 2025, RTX.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.16.1.