nwm_region_mgr.formreg.config_schema#

Configuration schema for the formulation regionalization application.

config_schema.py defines the Pydantic models that represent the configuration

Classes:
  • FormulationGeneralSettings: General settings for the formulation regionalization application.

  • BestFormulation: Configuration for determining the best formulation for each spatial unit.

  • FormulationSpatialUnitConfig: Spatial discretization settings for formulation regionalization.

  • MetricConfig: Configuration for an individual metric used in summary scoring.

  • MetricEvalPeriod: Configuration for the evaluation period of metrics to be used for screening donors.

  • FormulationSummaryScoreConfig: Configuration for computing a summary score for formulation as a weighted average of normalized metrics.

  • FormulationCostConfig: Computational cost of each formulation.

  • FormulationOutputConfig: Output configuration for formulation regionalization.

  • Config: Top-level configuration for formulation regionalization.

Classes

BestFormulation

Configuration for determining the best formulation for each spatial unit.

Config

Top-level configuration for formulation regionalization.

FormulationCostConfig

Computational cost of each formulation.

FormulationGeneralSettings

General settings for the formulation regionalization application.

FormulationOutputConfig

Output configuration for formulation regionalization.

FormulationSpatialUnitConfig

Spatial discretization settings for formulation regionalization.

FormulationSummaryScoreConfig

Configuration for computing a summary score for formulation as a weighted average of normalized metrics.

MetricConfig

Configuration for an individual metric used in summary scoring.

MetricEvalPeriod

Configuration for the evaluation period of metrics to be used for screening donors.

Orientation

Orientation for metrics: 'positive' means higher is better, 'negative' means lower is better.