Getting started
analyze
detect
deconvolve
synthetic
Algorithms
Reference
WellTest
Event
EventCollection
EventDetector
EventDetectorConfig
detect_events()
parse()
WellTestParser
bourdet_derivative()
horner_extrapolation()
mdh_extrapolation()
identify_flow_regimes()
reservoir_parameters()
deconvolve()
DeconvolutionResult
cross_validate_detector()
DetectorCVResult
horner_diagnostic_line()
dimensionless_storage()
radius_of_investigation()
bootstrap_score()
parameter_sensitivity()
apply_publication_style()
plot_overview()
plot_composite_report()
generate_synthetic_dst()
cmd_analyze()
cmd_detect()
cmd_deconvolve()
cmd_synthetic()
main()
quick_start.py
manual_split.py
deconvolution_demo.py
full_workflow.py
Parse a well-test ASCII gauge file into a clean DataFrame.
filepath (str | Path) – Path to the ASCII (.txt, .csv, .dat, .prn, …) file.
str
Path
p_range (tuple[float, float]) – Physical sanity bounds for pressure (psia). Values outside are NaN-ed.
tuple
float
t_range (tuple[float, float]) – Physical sanity bounds for temperature.
DataFrame
DataFrame with at least timestamp and pressure columns, plus
timestamp
pressure
temperature, delta_hours, and QC flags when available.
temperature
delta_hours