Installation

Requirements

  • Python 3.9 or newer

  • NumPy ≥ 1.22

  • Pandas ≥ 1.4

  • SciPy ≥ 1.8

  • Matplotlib ≥ 3.5

All dependencies are pure-Python wheels and install automatically with pip.

From PyPI

The release version:

pip install welltest-pta

With Excel-export support (openpyxl + xlsxwriter):

pip install "welltest-pta[excel]"

Everything (Excel + dev tooling + docs):

pip install "welltest-pta[all,dev,docs]"

From source (development install)

git clone https://github.com/geoharkat/welltest-pta.git
cd welltest-pta
pip install -e ".[dev]"

Run the test suite:

pytest -v

Build the docs locally:

pip install -e ".[docs]"
sphinx-build -b html docs/source docs/build/html

Verifying the installation

After installation a short Python session should look like this:

>>> import welltest_pta
>>> welltest_pta.__version__
'0.1.0'
>>> from welltest_pta import WellTest
>>> from welltest_pta.utils.synthetic import generate_synthetic_dst
>>> wt = WellTest.from_dataframe(generate_synthetic_dst(n_samples=4000))
>>> wt.events
EventCollection(2 events: 1 DD, 1 BU)

The CLI tool should also be on your $PATH:

$ welltest-pta --help

If installation succeeded but welltest-pta isn’t found, your pip Scripts/ directory may not be on PATH — add it or use python -m welltest_pta.cli instead.

Optional features

Some features depend on extras:

Feature

Extra to install

Excel export (.xlsx)

[excel]

Run the test suite

[dev]

Build documentation locally

[docs]