User guide

The user guide walks through each module — the engineering intent, the methods implemented, and the most important functions — with runnable examples and figures.

For an exact function-by-function reference (parameters, returns, references, full docstrings), see the API reference.

•   ge.soil — Properties & classification

  ---

  Phase relations, Atterberg, index properties, USCS, AASHTO, plasticity chart.

  Open

•   ge.lab — Laboratory testing

  ---

  Particle size, direct shear, triaxial, oedometer, Proctor, permeability, CBR.

  Open

•   ge.site — Site investigation

  ---

  SPT, CPT, field vane, pressuremeter, plate load, pile load, field permeability, DCP.

  Open

•   ge.profile — Layered ground model

  ---

  SoilProfile with total / pore / effective stress, plotting, DataFrame export.

  Open

•   ge.design — Engineering design

  ---

  Stress, Boussinesq, bearing capacity, settlement, earth pressure, walls, piles, slopes, seepage.

  Open

•   ge.dynamics — Soil dynamics

  ---

  Small-strain modulus, modulus reduction & damping, liquefaction triggering.

  Open

•   ge.io — Data I/O

  ---

  CSV, AGS4 (UK), GEF-CPT (Netherlands), CPT container class.

  Open