Skip to main content
Ctrl+K
🚧 Development documentation
HydroModPy 2.0.0a1 documentation - Home HydroModPy 2.0.0a1 documentation - Home
  • Home
  • Get started
  • User Guide
  • Python API
  • CLI
    • OO Patterns
    • Gallery
    • API Reference
    • Developer
    • About
  • GitHub
  • Issues
  • Google Group
  • Home
  • Get started
  • User Guide
  • Python API
  • CLI
  • OO Patterns
  • Gallery
  • API Reference
  • Developer
  • About
  • GitHub
  • Issues
  • Google Group

Section Navigation

  • Configuration reference
    • Configuration index
    • Complete annotated TOML reference
    • Schema Explorer
    • Recipes
    • [workflow] WorkflowConfig
    • [workspace] WorkspaceConfig
    • [geographic] GeographicConfig
    • [domain] DomainConfig
    • [data] DataManagersConfig
    • [flow] FlowConfig
    • [transport] TransportConfig
    • [simulation] SimulationConfig
    • [solver] SolverConfig
    • [modflownwt] ModflowConfig
    • [modflow6] Modflow6Config
    • [display] DisplayConfig
    • [persistence] PersistenceConfig
    • [analysis] AnalysisConfig
    • [overview] OverviewConfig
    • [mesh_catchment] MeshCatchmentConfig
    • [mesh_input] MeshInputConfig
    • [calibration] CalibrationConfig
    • [testbed] TestbedConfig
    • [site_selection] SiteSelectionConfig
    • [hydrometry] HydrometryConfig
  • Workflow families and modes
    • Overview Workflow
    • Simulation Workflow
    • Testbed Workflow
    • Regional Lab Profile
    • Site Selection Workflow
    • Calibration Workflow
    • Comparison Workflow
  • Concepts
    • Workspace Layout
    • Project vs Run
    • Simulation Comparison Workflow
    • Comparison Output Reading Order
    • How To Read Gallery, Comparison, and Validation Pages
  • Cookbook
  • Theory
    • Foundations
      • System Scope And Assumptions
      • Groundwater Flow Problem Definition
    • Hydrology
      • Hydrological Forcing Chain
      • Forcing Time Aggregation And First_Clim
      • Recharge And Surface-Exchange Semantics
      • Stream, Ocean, And Drainage Semantics
      • Simulated Active Network
    • Mesh
      • Mesh and discretization strategies
      • Regular and irregular mesh cell budgets
      • Field-to-cell parameter transfer
      • Mesh quality and acceptance criteria
      • Vertical representation and storage assumptions
      • XT3D on irregular DISV meshes
    • Solvers
      • Flow Solvers
        • MODFLOW Flow Family
      • Mesh And Discretization Strategies
      • Field-To-Cell Parameter Transfer
      • Vertical Representation And Storage Assumptions
      • Mesh Quality And Acceptance Criteria
      • MODFLOW Governing Equation And CVFD Formulation
      • MODFLOW 6 Versus MODFLOW-NWT: Scientific Comparison
      • MODFLOW Package Semantics And Option Selection
      • XT3D On Irregular DISV Meshes
      • Worked MODFLOW Case: Dupuit Fixed Head 1D
      • Worked MODFLOW Case: Linearized Unconfined Periodic Recharge 1D
      • Worked MODFLOW Case: Nancon Transient NWT With ETP To EVT
      • Solver Capability Matrix
      • Boussinesq PETSc Validation Results
    • Boussinesq
    • Streams and seepage
      • Conceptual Model
      • Worked examples
      • Status and limitations
      • Nancon K-sweep results
      • Network metrics and extreme K-sweep
      • Boundary semantics
      • Simulated active network
    • Calibration
      • Calibration Inverse Problem Formulation
      • Calibration Methods Implemented In HydroModPy
    • Notation
    • Bibliography
  • CLI Reference
  • Data loading
    • Retrieval Workflow
    • Runs And Figures
    • Provider Replay Cases
    • Custom Data
    • Cache And Lockfiles
    • DEM
    • Geology
    • Hydrography
    • Hydrometry
    • Piezometry
    • Intermittency
    • Water Quality
    • Recharge
    • Precipitation
    • ETP
    • Temperature
    • Wind
    • Humidity
    • Radiation
    • Soil Moisture
    • Runoff
    • Oceanic
  • Results and Exports
  • The catalog door
  • Figure Catalog
  • Catchment HTML Reports
  • Project API
  • Solvers
  • MODFLOW 6 PRT Particle Tracking
  • Troubleshooting

Indices

  • General Index
  • Python Module Index
  • User Guide
  • Concepts
  • How To Read Gallery, Comparison, and Validation Pages

How To Read Gallery, Comparison, and Validation Pages#

HydroModPy exposes several kinds of result pages. They do not answer the same question, so it helps to separate them early.

Important

Use this page after one walkthrough. It is meant to help you interpret published result pages, not to replace the editable case guides.

If you need the actual run workflow that generates comparison outputs, use Simulation Comparison Workflow first and come back here to interpret the produced pages and metrics.

If you already have one comparison output folder in hand and want a strict artifact-by-artifact reading order, use Comparison Output Reading Order.

Know which question the page answers#

Page type

Main question

What not to infer too quickly

Example or walkthrough page

How do I run and modify one workflow?

It is not automatically a numerical validation of the method.

Capability-gallery case

What does this workflow or artifact look like as a stable, curated snapshot?

It is not the full run workspace and not always the best place to learn the editable config from scratch.

Comparison page

How different are two solver outputs on the same saved support?

A small discrepancy is not the same thing as analytical correctness.

Validation page

Does one numerical path reproduce an analytical or trusted reference within explicit tolerances?

Good validation does not automatically mean every complex real-case setup is configured correctly.

Comparison pages#

Use a comparison page such as Shared-Mesh Solver Comparison on Naizin when the main question is solver agreement.

Read them in this order:

  1. Confirm support equality. The comparison is strongest when both runs use the same saved mesh or grid.

  2. Confirm observable equality. Make sure the compared field really represents the same quantity in both runs.

  3. Read the parity shape. A compact cloud around the 1:1 line means broad agreement.

  4. Read MAE and RMSE together. MAE is the typical mismatch; RMSE highlights stronger local deviations.

Validation pages#

Validation pages under Validation Benchmarks answer a different question: whether one solver path matches a reference solution or a benchmark expectation.

Read them in this order:

  1. Read the Case Setup. This tells you what is actually being benchmarked.

  2. Read the Analytical Reference if present. This is the truth model for the page.

  3. Read Solver Coverage. Some pages compare several backends side by side.

  4. Read the displayed metrics and tolerances. A passing case means the chosen metrics stayed within explicit thresholds, not that every output is exactly equal.

Static gallery pages versus editable configs#

The capability gallery is intentionally static and versioned. It is excellent for:

  • scanning one family of cases quickly,

  • teaching from stable figures,

  • checking which artifacts are considered documentation-worthy.

It is not the best place to learn the editable case structure from scratch. When you want that, go back to:

  • Data Overview Walkthrough

  • Simulation Walkthrough

  • Comparison Output Reading Order

  • Choose Your First Workflow

previous

Comparison Output Reading Order

next

Cookbook

On this page
  • Know which question the page answers
  • Comparison pages
  • Validation pages
  • Static gallery pages versus editable configs

© Copyright 2021.

Created using Sphinx 7.4.7.