API reference

The full per-function reference, auto-generated from the package's docstrings via mkdocstrings. Every function lists its signature, parameters, returns, and the textbook reference that documents the underlying formula.

For a guided walkthrough with context and figures, see the user guide instead.

•   ge.soil

  ---

  14 functions — phase relations, classification.

  Open

•   ge.lab

  ---

  30 functions — particle size, shear, consolidation, compaction, permeability, CBR.

  Open

•   ge.site

  ---

  46 functions — SPT, CPT, vane, PMT, PLT, pile load, field permeability, DCP.

  Open

•   ge.profile

  ---

  2 classes + 2 helpers — Soil, SoilProfile, mesh, log_plot.

  Open

•   ge.design

  ---

  50+ functions across 9 sub-modules — stress, bearing, settlement, earth pressure, walls, piles, slopes, seepage.

  Open

•   ge.dynamics

  ---

  11 functions — Gmax, modulus reduction, damping, liquefaction triggering.

  Open

•   ge.io

  ---

  3 readers + 1 container class — CSV, AGS4, GEF-CPT, CPT.

  Open