welltest-pta

Getting started

  • Installation
    • Requirements
    • From PyPI
    • From source (development install)
    • Verifying the installation
    • Optional features
  • Quick start
    • 1. Load gauge data
    • 2. Inspect the catalogue
    • 3. Per-event analysis
    • 4. Manual splitting (when CV score is marginal)
    • 5. Multi-event deconvolution
    • 6. Composite report + bulk export
    • Next steps
  • Command-line interface
    • analyze — full pipeline
    • detect — print catalogue only
    • deconvolve — multi-event vSH04
    • synthetic — generate test data
    • Global options
    • Exit codes

Algorithms

  • Event detection — V8.1 algorithm
    • Pipeline overview
    • Phase 0 — Smoothing & noise floor
    • Phase 1 — Reservoir pressure
    • Phase 2 — Edge masking
    • Phase 3 — Boundary detection
    • Phase 4 — Zone classification
    • Phase 5 — Cleanup
    • Phase 5b — Tail trim (V8.1)
    • Configuration
    • When to override the auto-detector
  • Multi-event deconvolution
    • Mathematical framework
    • The vSH04 encoded formulation
      • Choosing \(\nu\)
    • API
    • Implementation notes
    • Best-practice checklist
    • References
  • Cross-validation
    • Three independent stability checks
    • Composite score
    • Usage
    • Sample report
    • When the score is low

Reference

  • API reference
    • Top-level public API
      • welltest_pta.WellTest
        • WellTest
      • welltest_pta.Event
        • Event
      • welltest_pta.EventCollection
        • EventCollection
      • welltest_pta.EventDetector
        • EventDetector
      • welltest_pta.EventDetectorConfig
        • EventDetectorConfig
      • welltest_pta.detect_events
        • detect_events()
      • welltest_pta.parse
        • parse()
      • welltest_pta.WellTestParser
        • WellTestParser
      • welltest_pta.bourdet_derivative
        • bourdet_derivative()
      • welltest_pta.horner_extrapolation
        • horner_extrapolation()
      • welltest_pta.mdh_extrapolation
        • mdh_extrapolation()
      • welltest_pta.identify_flow_regimes
        • identify_flow_regimes()
      • welltest_pta.reservoir_parameters
        • reservoir_parameters()
      • welltest_pta.deconvolve
        • deconvolve()
      • welltest_pta.DeconvolutionResult
        • DeconvolutionResult
      • welltest_pta.cross_validate_detector
        • cross_validate_detector()
      • welltest_pta.DetectorCVResult
        • DetectorCVResult
    • Submodules
      • Parser
        • welltest_pta.parser
      • Detection
        • welltest_pta.detection.detector
      • Events
        • welltest_pta.events
      • WellTest orchestrator
        • welltest_pta.welltest
      • Analysis primitives
        • welltest_pta.analysis.bourdet
        • welltest_pta.analysis.horner
        • horner_diagnostic_line()
        • welltest_pta.analysis.mdh
        • welltest_pta.analysis.flow_regimes
        • welltest_pta.analysis.reservoir
        • dimensionless_storage()
        • radius_of_investigation()
      • Deconvolution
        • welltest_pta.analysis.deconvolution
      • Cross-validation
        • welltest_pta.validation.cross_validation
        • bootstrap_score()
        • parameter_sensitivity()
      • Visualization
        • welltest_pta.visualization.composite
        • apply_publication_style()
        • plot_overview()
        • plot_composite_report()
      • Utilities
        • welltest_pta.utils.synthetic
        • generate_synthetic_dst()
      • Command-line interface
        • welltest_pta.cli
        • cmd_analyze()
        • cmd_detect()
        • cmd_deconvolve()
        • cmd_synthetic()
        • main()
  • Examples
    • quick_start.py
    • manual_split.py
    • deconvolution_demo.py
    • full_workflow.py
    • Running the examples
  • Contributing
    • Reporting bugs
    • Setting up a development environment
    • Running the test suite
    • Linting and type checking
    • Building the documentation
    • Pull request workflow
    • Release process (maintainers)
    • Coding style
    • Code of conduct
  • Changelog
    • Changelog
      • [0.1.0] — 2026-05-04
        • Added
welltest-pta
  • Overview: module code

All modules for which code is available

  • welltest_pta.analysis.bourdet
  • welltest_pta.analysis.deconvolution
  • welltest_pta.analysis.flow_regimes
  • welltest_pta.analysis.horner
  • welltest_pta.analysis.mdh
  • welltest_pta.analysis.reservoir
  • welltest_pta.cli
  • welltest_pta.detection.detector
  • welltest_pta.events
  • welltest_pta.parser
  • welltest_pta.utils.synthetic
  • welltest_pta.validation.cross_validation
  • welltest_pta.visualization.composite
  • welltest_pta.welltest

© Copyright 2026, Ismail Harkat (geoharkat).

Built with Sphinx using a theme provided by Read the Docs.