# driven_pile

> Long-term capacity of driven piles from the pile-driving log: a pore-pressure-tracking inversion of blow counts.

## Docs

### API Reference

#### Inputs
> The driving record, the pile and hammer that produced it, and the ground it was driven through.

- [DriveLog](https://lornearnold.github.io/driven-pile/reference/DriveLog.html): A pile-driving record, one entry per logged foot
- [Pile](https://lornearnold.github.io/driven-pile/reference/Pile.html): Pile geometry and stiffness
- [Hammer](https://lornearnold.github.io/driven-pile/reference/Hammer.html): Driving hammer
- [SoilProfile](https://lornearnold.github.io/driven-pile/reference/SoilProfile.html): Ground conditions at a pile location
- [bpm_to_stroke](https://lornearnold.github.io/driven-pile/reference/bpm_to_stroke.html): Hammer stroke from the blow rate of a free-falling ram
- [stroke_to_bpm](https://lornearnold.github.io/driven-pile/reference/stroke_to_bpm.html): Blow rate of a free-falling ram from its stroke; inverse of `bpm_to_stroke`

#### Options
> Model parameters and Monte Carlo settings, with the published values as defaults.

- [ModelOptions](https://lornearnold.github.io/driven-pile/reference/ModelOptions.html): Parameters of the drive model
- [MonteCarloOptions](https://lornearnold.github.io/driven-pile/reference/MonteCarloOptions.html): Monte Carlo settings

#### Pipeline
> One function per stage of the method, and one call that runs them all.

- [analyze](https://lornearnold.github.io/driven-pile/reference/analyze.html): Characterize the soil from a driving log and estimate long-term capacity
- [prepare_target](https://lornearnold.github.io/driven-pile/reference/prepare_target.html): Build the capacity target from a driving log
- [sweep_top_phi](https://lornearnold.github.io/driven-pile/reference/sweep_top_phi.html): Sweep a constant top-segment friction angle and find the admissible band
- [run_drive](https://lornearnold.github.io/driven-pile/reference/run_drive.html): Characterize every foot sequentially from the capacity target, top down
- [long_term_capacity](https://lornearnold.github.io/driven-pile/reference/long_term_capacity.html): Long-term shaft and toe resistance of a `DriveResult`
- [monte_carlo](https://lornearnold.github.io/driven-pile/reference/monte_carlo.html): Realizations of the long-term capacity under the five uncertainty sources

#### Results
> Dataclasses of plain NumPy arrays.

- [Analysis](https://lornearnold.github.io/driven-pile/reference/Analysis.html): Everything `analyze` produces
- [Target](https://lornearnold.github.io/driven-pile/reference/Target.html): Per-foot capacity target and static soil state on the analysis grid
- [TopPhiBand](https://lornearnold.github.io/driven-pile/reference/TopPhiBand.html): Admissible friction angles for the unlogged top segment
- [DriveResult](https://lornearnold.github.io/driven-pile/reference/DriveResult.html): Soil characterization and capacities from one drive-model run
- [MonteCarloResult](https://lornearnold.github.io/driven-pile/reference/MonteCarloResult.html): Monte Carlo realizations of the long-term capacity

#### DriveResult Methods
> Methods for the DriveResult class

- [DriveResult.n_logged](https://lornearnold.github.io/driven-pile/reference/DriveResult.n_logged.html)
- [DriveResult.logged](https://lornearnold.github.io/driven-pile/reference/DriveResult.logged.html)
- [DriveResult.reason_counts](https://lornearnold.github.io/driven-pile/reference/DriveResult.reason_counts.html)
- [DriveResult.fraction_liquefied](https://lornearnold.github.io/driven-pile/reference/DriveResult.fraction_liquefied.html)
- [DriveResult.plot_profile](https://lornearnold.github.io/driven-pile/reference/DriveResult.plot_profile.html)
- [DriveResult.plot_fit](https://lornearnold.github.io/driven-pile/reference/DriveResult.plot_fit.html)

#### Equation-level functions
> The equations of the method, importable from the submodules for teaching and testing.

- [formulas.elastic_set](https://lornearnold.github.io/driven-pile/reference/formulas.elastic_set.html)
- [formulas.danish_capacity](https://lornearnold.github.io/driven-pile/reference/formulas.danish_capacity.html)
- [preprocess.smooth_capacity](https://lornearnold.github.io/driven-pile/reference/preprocess.smooth_capacity.html)
- [preprocess.sigma_v0_profile](https://lornearnold.github.io/driven-pile/reference/preprocess.sigma_v0_profile.html)
- [preprocess.extend_to_mudline](https://lornearnold.github.io/driven-pile/reference/preprocess.extend_to_mudline.html)
- [preprocess.residual_scale](https://lornearnold.github.io/driven-pile/reference/preprocess.residual_scale.html)
- [bearing.nq_vesic](https://lornearnold.github.io/driven-pile/reference/bearing.nq_vesic.html)
- [bearing.rigidity_index](https://lornearnold.github.io/driven-pile/reference/bearing.rigidity_index.html)
- [bearing.toe_bearing](https://lornearnold.github.io/driven-pile/reference/bearing.toe_bearing.html)
- [bearing.phi_from_toe_bearing](https://lornearnold.github.io/driven-pile/reference/bearing.phi_from_toe_bearing.html)
- [bearing.phi_from_toe_bearing_grid](https://lornearnold.github.io/driven-pile/reference/bearing.phi_from_toe_bearing_grid.html)
- [spt.phi_from_n160](https://lornearnold.github.io/driven-pile/reference/spt.phi_from_n160.html)
- [spt.n160_from_phi](https://lornearnold.github.io/driven-pile/reference/spt.n160_from_phi.html)
- [shaft.coyle_castello_k](https://lornearnold.github.io/driven-pile/reference/shaft.coyle_castello_k.html)
- [shaft.nordlund_k_delta](https://lornearnold.github.io/driven-pile/reference/shaft.nordlund_k_delta.html)
- [shaft.fs_coyle_castello](https://lornearnold.github.io/driven-pile/reference/shaft.fs_coyle_castello.html)
- [shaft.interface_alpha](https://lornearnold.github.io/driven-pile/reference/shaft.interface_alpha.html)
- [shaft.fs_partially_liquefied](https://lornearnold.github.io/driven-pile/reference/shaft.fs_partially_liquefied.html)
- [liquefaction.delta_n_fines](https://lornearnold.github.io/driven-pile/reference/liquefaction.delta_n_fines.html)
- [liquefaction.n160_clean_sand](https://lornearnold.github.io/driven-pile/reference/liquefaction.n160_clean_sand.html)
- [liquefaction.crr_m75](https://lornearnold.github.io/driven-pile/reference/liquefaction.crr_m75.html)
- [liquefaction.k_sigma](https://lornearnold.github.io/driven-pile/reference/liquefaction.k_sigma.html)
- [liquefaction.crr_15](https://lornearnold.github.io/driven-pile/reference/liquefaction.crr_15.html)
- [liquefaction.csr_driving](https://lornearnold.github.io/driven-pile/reference/liquefaction.csr_driving.html)
- [liquefaction.cycles_to_liquefaction](https://lornearnold.github.io/driven-pile/reference/liquefaction.cycles_to_liquefaction.html)
- [liquefaction.ru_linear](https://lornearnold.github.io/driven-pile/reference/liquefaction.ru_linear.html)
- [liquefaction.residual_strength](https://lornearnold.github.io/driven-pile/reference/liquefaction.residual_strength.html)
- [capacity.shaft_long_term](https://lornearnold.github.io/driven-pile/reference/capacity.shaft_long_term.html)
- [capacity.toe_end_of_drive](https://lornearnold.github.io/driven-pile/reference/capacity.toe_end_of_drive.html)
- [characterization.triggering_state](https://lornearnold.github.io/driven-pile/reference/characterization.triggering_state.html)
- [characterization.characterize_foot](https://lornearnold.github.io/driven-pile/reference/characterization.characterize_foot.html)