well-schematics Python package documentation

well-schematics is a package to help with making schematic diagrams of the construction of boreholes and wells in matplotlib.

This project is based at GitHub.

Installation

well-schematics can be installed from PyPI:

$ pip install well-schematics

And updated from PyPI:

$ pip install -U well-schematics

The well-schematics PyPI package will install a Python module well_schematics:

>>> import well_schematics as ws

Examples

import well_schematics as ws

ws.plot_single_diameter_well(
    [
        {"type": "casing", "top": -0.5, "bottom": 27},
        {"type": "screen", "top": 27, "bottom": 36},
    ]
)
_images/example_simplest.png

well_schematics developer API

Groundwater resources

well_schematics.plot_single_diameter_well(segments, ax=None, tight_layout=True, depth_tick_markers=False, pipe_width=0.08, hatch_density=3)[source]

Draw casing in a well which is a single diameter construction.

Parameters:
  • segments (sequence of dicts) – each dict should be in the form {"type": <str>, "top": <float>, "bottom": <float>}. The “type” should be either “casing”, “pipe”, “blank”, or “sump”, or a production zone type (either “screen”, “slotted casing” or “open hole”). “top” and “bottom” are the top and bottom of each segment.
  • ax (matplotlib.Axes) – to draw in
  • tight_layout (bool) – run tight_layout() on ax.figure to rearrange things to fit.
  • depth_tick_markers (bool) – show tick markers for the vertical depth axis. Labels will always appear.
  • pipe_width (float) – width of pipe
  • hatch_density (int) – density of screen hatching

Returns: a list of the artists created.

Indices and tables