Installation

wellplot is published on PyPI. Most users should install the package into a normal Python environment with pip.

Base Install

python -m pip install wellplot

This installs the core renderer, YAML support, NumPy, Matplotlib, and schema validation dependencies.

Optional Extras

Install only the adapters and runtime features you need:

python -m pip install "wellplot[las]"
python -m pip install "wellplot[dlis]"
python -m pip install "wellplot[pandas]"
python -m pip install "wellplot[interactive]"
python -m pip install "wellplot[notebook]"
python -m pip install "wellplot[units]"
python -m pip install "wellplot[mcp]"

Common combinations:

python -m pip install "wellplot[las,notebook]"
python -m pip install "wellplot[dlis,notebook]"
python -m pip install "wellplot[las,dlis,pandas,notebook,interactive,units]"

If you want every optional dependency exposed by the package metadata:

python -m pip install "wellplot[all]"

Experimental MCP Install

Install the MCP surface only when you need agent-driven logfile workflows:

python -m pip install "wellplot[mcp]"

Verify that the stdio entry point was installed:

python - <<'PY'
import shutil

path = shutil.which("wellplot-mcp")
print(path)
if path is None:
    raise SystemExit("wellplot-mcp entry point was not installed")
PY

Launch behavior:

• wellplot-mcp starts a stdio server and stays attached to the client session
• the server root is the current working directory when the process starts
• logfile paths, referenced source data, saved YAML files, export directories, and render outputs must all resolve inside that root

Typical client registration:

{
  "mcpServers": {
    "wellplot": {
      "command": "wellplot-mcp",
      "cwd": "/absolute/path/to/job-root"
    }
  }
}

Verify The Install

wellplot --help
python - <<'PY'
import wellplot
print(wellplot.__version__)
PY

Running Repository Examples

The package can be installed from PyPI, but the bundled example files and public sample data live in the repository. To run the production examples exactly as documented, clone the repository and run commands from the repository root.

git clone https://github.com/cschrupp/wellplot.git
cd wellplot
python -m pip install "wellplot[las,dlis,notebook]"
wellplot validate examples/production/forge16b_porosity_example/full_reconstruction.log.yaml

Contributor Environment

Contributors use uv for reproducible dependency resolution and local checks. This is not required for normal installed-package usage.

uv sync
uv run ruff check .
uv run pytest tests/test_mcp_service.py tests/test_mcp_server.py tests/test_pipeline.py tests/test_cli.py tests/test_public_api.py
uv run --with mcp pytest tests/test_mcp_server.py

Build the local documentation:

uv sync --group docs
uv run --group docs mkdocs build --strict

Build and smoke-test a local wheel:

uv build
python -m venv .smoke-venv
./.smoke-venv/bin/pip install --upgrade pip
./.smoke-venv/bin/pip install dist/*.whl
./.smoke-venv/bin/wellplot --help
MPLBACKEND=Agg ./.smoke-venv/bin/python scripts/smoke_installed_wheel.py

Python Version

wellplot targets Python >=3.11.