API reference

Auto-generated from the package docstrings. The most-used classes are Mesh2D, Config, and Solver2D.

A name re-exported at the top level is documented in that form, because that is how you import it and how every page writes it: Solver2D, not geoswe.solver.Solver2D. What is not re-exported keeps its module, so run_cached is geoswe.compressed_solver.run_cached().

The solver

• Solvers and configuration
  • Config
  • Solver2D
  • Solver1D
• Meshes and backend
  • Mesh2D
  • Mesh1D
  • Backend control
• Forcings
  • RainfallForcing
  • StageBoundary
  • Fetching a tide-gauge record
• Compressed active-cell solver
  • CompressedSolver
  • Cache replay
  • The compressed mesh
• High-level runner (runlib)
  • Case loading
  • Options of the case runners
  • Driver and cache replay

The three modules below prepare the inputs of a run and collect its output at gauge points. They ship in the wheel and are supported API as of 1.1.0, under the same compatibility promise as the solver, but they are not the solver: a case you already hold as NumPy arrays needs none of them. Two of them want extras, io and forcings; each page says which, and gauges needs neither.

Preparing inputs

• Case preparation from raw data
  • The grid
  • The forcings and the coast
• GeoTIFF input and output
  • Reading and writing
  • Reprojection and roughness
• Gauge time series
  • gauges_from_coords()
  • GaugeBank
  • GaugeRecorder