API reference

Functions and classes are documented by their defining module. Common entry points are also available from import unsatstab as us.

• Parameters (unsatstab.parameters): Hydraulic and strength properties, initial conditions, and model resolution.
• Rainfall (unsatstab.rainfall): Piecewise-constant rainfall forcing and optional antecedent histories.
• Basal boundaries (unsatstab.boundaries): Drainage capacity and basal boundary assumptions.
• Column solver (unsatstab.solver): Single-column infiltration, storage, and stability simulation.
• Column results (unsatstab.results): Time series, depth profiles, and exported column results.
• Spatial slope units (unsatstab.slope_units): Spatial schemas, input readers, distributed simulations, and result exports.
• Analytical flow (unsatstab.analytical): Gardner relations and the analytical unsaturated-flow response.
• Characteristic roots (unsatstab.roots): Root equations and numerical solution of the characteristic spectrum.
• Water table (unsatstab.water_table): Fillable pore volume, retained storage, and water-table rise.
• Slope stability (unsatstab.stability): Infinite-slope factor of safety and effective-stress calculations.

Verified source equation numbers and implementation adaptations are summarized in equation provenance.