Skip to main content

The statistical process control library for Python: control charts, capability analysis, and measurement systems analysis, validated against published reference values.

Project description

shewhart

CI PyPI License: MIT

Statistical process control for Python.

Control charts with the standard run rules, process capability analysis, and measurement systems analysis. Results are computed from the published formulas and checked against reference values in the test suite.

Named after Walter A. Shewhart.

Motivation

R has had a maintained SPC package (qcc) since 2004. Python does not: the existing packages are unmaintained, cover only fragments of the toolkit, and none of them validate their output against reference data. This library is an attempt to fix that, with a few specific goals:

  • correct constants and estimators, validated against published values
  • a clean separation between estimating control limits (Phase I) and monitoring new data against frozen limits (Phase II)
  • rule violations as structured data, usable in pipelines, not only in plots
  • an API that works headless, so a weekly control chart review can run as a cron job
pip install shewhart

Documentation: https://bertanucar.github.io/shewhart/

Status

Version 0.1.1 is on PyPI. Implemented and tested:

  • review(): one call that selects the right chart, checks the assumptions, and returns a structured verdict (see below)
  • control charts: I-MR, Xbar-R, Xbar-S, p, np, c, u (stair-step limits for varying subgroup sizes), Laney p'/u' for overdispersed data, EWMA (exact and asymptotic limits), tabular CUSUM, run chart with the four runs tests, Pareto analysis
  • time-window subgrouping on DatetimeIndex data (subgroup="1H")
  • process capability: Cp, Cpk, Pp, Ppk, Cpm with confidence intervals (chi-square for Cp/Pp, Bissell approximation for Cpk/Ppk), within vs overall sigma, expected and observed PPM, stability gate, normality check; non-normal data via fitted models (percentile method) or Box-Cox
  • tolerance intervals: normal (Howe k2, anchored to the NIST handbook factor) and nonparametric (Wilks)
  • named sigma estimators: average or median moving range, Sbar, pooled
  • Nelson rules 1 to 8 and Western Electric rules 1 to 4, returned as structured signal events
  • chart constants (d2, d3, c4, A2, A3, D3, D4, B3, B4), computed from their defining integrals rather than copied from tables
  • baseline freezing and reuse (JSON), self-contained HTML reports
  • a reference-case validation suite (tests/validation_cases.json), anchored externally: NIST StRD certified values (Michelso, NumAcc1) and the NIST/SEMATECH e-Handbook EWMA worked example are reproduced in CI

Usage

One call, if you just want a verdict:

import shewhart as sw

rv = sw.review(df, value="torque", lsl=9.95, usl=10.05)
rv.ok          # in control, capable, no failed checks
rv.headline    # "In control: no rule violations on the imr chart. Cpk 1.41 (capable)."
rv.to_dict()   # the full verdict as JSON-safe data

review() selects the chart from the data shape, checks the assumptions, and refuses to report capability on an unstable process. The individual analyses behind it:

r = sw.imr(df, value="torque", rules="nelson")
r.ok           # False if any rule fired
r.summary()    # plain text verdict
r.table        # per-point DataFrame with signal flags
r.plot()

Subgrouped data:

r = sw.xbar_r(df, value="torque", subgroup="batch")

Fit limits once, then monitor new data against them:

sw.imr(df_baseline, value="torque").baseline.save("line3_baseline.json")

# later, e.g. in a scheduled job:
r = sw.imr(df_new, value="torque", limits="line3_baseline.json")
sys.exit(0 if r.ok else 1)

Capability analysis, with the confidence intervals that the usual hand-rolled Cpk calculation cannot give you:

r = sw.capability(df, value="dia", lsl=9.95, usl=10.05)
r.stats["cpk"], r.stats["cpk_lci"], r.stats["cpk_uci"]

Several analyses in one self-contained HTML file, e.g. as a weekly job:

sw.report([
    sw.imr(df, value="torque", limits="line3_baseline.json"),
    sw.p_chart(df2, defectives="rejects", size="inspected"),
    sw.capability(df, value="torque", lsl=9.5, usl=11.0),
], "weekly_report.html", title="Line 3 weekly")

Every analysis returns the same Result object: named statistics, a tidy per-point table, a tuple of structured rule violations, and provenance metadata (library version, input hash, timestamp).

If you are wiring this into an AI agent, read Statistics is not a language task first.

Roadmap

Version Scope
0.2 measurement systems analysis: ANOVA gauge R&R (crossed and nested), Type 1 studies, attribute agreement
0.3 process screening across many characteristics, drift monitoring with control chart semantics

Out of scope: DOE (see pyDOE3), reliability engineering (see reliability), general statistics (see statsmodels), GUIs.

License

MIT. Written and maintained by Bertan Ucar, PhD researcher at Tsinghua University.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shewhart-0.1.1.tar.gz (59.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shewhart-0.1.1-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file shewhart-0.1.1.tar.gz.

File metadata

  • Download URL: shewhart-0.1.1.tar.gz
  • Upload date:
  • Size: 59.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shewhart-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ab13279c24cac188dcbd1a81b36728c7b7047398e953af5fd99fa01398bfceb5
MD5 d8a9839e4947d4fa29f0cbf2748ab712
BLAKE2b-256 20be9e3152129b6a3e02031a9415979259fd6c0589f14245fc4c8b58477bbc5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for shewhart-0.1.1.tar.gz:

Publisher: release.yml on bertanucar/shewhart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shewhart-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: shewhart-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shewhart-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a425b9634746e318bfabb03839cdb07ba32cfbb887d0d3b7e4b0d345f6a05ea6
MD5 33ab3e80d29fdf4e756cd35c42fce370
BLAKE2b-256 4d22938ede1780ba70a046966326621b55ccf21703265d15d02c08fc738e2daf

See more details on using hashes here.

Provenance

The following attestation bundles were made for shewhart-0.1.1-py3-none-any.whl:

Publisher: release.yml on bertanucar/shewhart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page