Skip to main content

TPxLab

Reproducible global deconvolution and quantification of temperature-programmed catalyst data.

CI Python 3.10+ License: MIT

TPxLab turns CSV/XLSX TPR, TPD, and TPO curves into inspectable baseline corrections, editable peak components, simultaneous mixed-model fits, coordinate-aware integrals, unit-checked quantities, diagnostics, figures, and reproducible exports. One AnalysisService powers the Python API, CLI, and Tkinter GUI.

Actual TPxLab global deconvolution of the bundled overlapping example

Install

Install the current stable release from PyPI:

python -m pip install tpxlab

For development or to run the bundled examples from a source checkout:

git clone https://github.com/hdkim99/TPxLab.git
cd TPxLab
python -m pip install -e .

The repository social-preview candidate is the actual bundled-example result, not a mock interface.

30-second global quickstart

For the bundled overlapping example in a source checkout:

tpxlab analyze examples/overlapping_tpr.csv \
  --components-config examples/overlapping_components.json \
  --baseline linear \
  --output examples/output/global-analysis.xlsx \
  --figure examples/output/global-analysis.png

tpxlab-gui

The GUI follows: load and map columns/units -> baseline and detect -> add/update/remove components -> choose model, center/width bounds, fixed/shared width constraints -> fit and quantify -> inspect components/total/residual -> export. Every edit is passed through the service to the same scientific core used by the CLI.

Python API

from tpxlab import AnalysisService, AnalysisSettings, PeakSeed
from tpxlab.io import load_raw_data

raw = load_raw_data("examples/overlapping_tpr.csv")
components = [
    PeakSeed(
        332,
        220,
        540,
        model="gaussian",
        center_lower=310,
        center_upper=350,
        width_lower=5,
        width_upper=35,
    ),
    PeakSeed(
        373,
        220,
        540,
        model="lorentzian",
        center_lower=355,
        center_upper=390,
        width_lower=4,
        width_upper=25,
    ),
    PeakSeed(
        414,
        220,
        540,
        model="voigt",
        center_lower=395,
        center_upper=430,
        width_lower=4,
        width_upper=28,
    ),
]
result = AnalysisService().analyze(
    raw,
    AnalysisSettings(baseline_method="linear", fit_mode="global"),
    components,
)
print(result.global_fit.identifiable, result.global_fit.statistics.r_squared)

Support status in v0.2.x

Capability Status Notes
CSV and XLSX import Supported explicit or conservative automatic 3-column mapping
Linear, polynomial, ALS baseline Supported raw data is copied and read-only
Positive/negative detector peaks Supported explicit polarity; raw/baseline stay in detector coordinates
Optional Savitzky-Golay smoothing Supported parameters exported
Peak detection and manual edits Supported positive-area peaks after explicit polarity; add/update/remove in GUI
Simultaneous global deconvolution Supported one summed residual; mixed Gaussian/Lorentzian/Voigt
Center/width constraints Supported positive areas; validated bounds and fixed parameters
Shared width constraint Supported named shared sigma or gamma groups only
Identifiability diagnostics Supported ordering, dof, rank, condition, active bounds, covariance status
Independent bounded fitting Supported v0.1-compatible mode; not overlapping deconvolution
Trapezoid/Simpson integration Supported actual time coordinates, including irregular sampling
Calibration + sample-mass quantification Supported Pint dimensional validation
Explicit reduction degree Experimental API only; user supplies stoichiometry
Draft interchange metadata Experimental org.tpxlab.analysis/0.2-draft; no integration adapter yet
Asymmetric peaks, automatic model selection Planned not implemented
TPSR and pulse chemisorption workflows Planned not implemented

Outputs

XLSX contains Raw, Processed, Peaks, Components, Global_fit, Settings, Metadata, and QC sheets; a directory destination writes the same layers as CSV. Exports include original channels, component curves, total curve, residual, exact constraints, parameter ordering, component parameters/Tmax/area/height/FWHM, local standard errors, component and global covariance, RSS/RMSE/R²/dof, Jacobian rank, condition number, optimizer status, active bounds, numerical rank tolerance, integration source, units, source file, and QC issues. PNG/SVG/PDF figures include raw/baseline, components/total, and residual.

Scientific scope and limitations

  • Global mode minimizes one residual vector between the complete processed signal and the sum of all components. It is not a sum of separately fitted curves.
  • Nonlinear decomposition can be non-unique. A full-rank local Jacobian is necessary, not sufficient, for physical uniqueness. Rank-deficient fits report unavailable covariance; boundary solutions report boundary-limited uncertainty.
  • Reported covariance is the local linearized least-squares approximation. It does not replace replicate experiments, profile likelihood, or domain-informed uncertainty.
  • A shared sigma or gamma should be used only when components have a defensible common broadening mechanism. TPxLab never decides that assumption automatically.
  • Global component quantification integrates each fitted component against measured time. Independent mode integrates the observed bounded region. The export labels this source.
  • Peak fit area is with respect to temperature; calibrated detector integration is with respect to time. Both are labeled separately.
  • Baseline and model choices remain analytical assumptions requiring residual review. TPxLab orients explicitly declared positive/negative detector responses into positive-area models and does not infer polarity, gas identity, chemistry, oxidation state, stoichiometry, or expected consumption.
  • Non-monotonic temperature programs are flagged; repeated temperature ranges require user review.

Definitions, equations, parameter ordering, and validation details are in Scientific methods. The reviewed, opt-in actual-research-data source is documented in Public data sources. The provisional, explicitly non-stable export contract is in Interchange metadata.

Related tools

  • Ordifile — chromatographic data standardization.
  • ReactorCheck — catalytic reactor calculation and QC.
  • OperandoMerge — heterogeneous experiment timeline alignment.

These are independent repositories. Direct cross-project adapters are planned interoperability, not a current TPxLab feature.

Development

python -m pip install -e '.[dev]'
ruff check .
mypy src
pytest
python -m build
twine check dist/*

Runtime dependencies use permissive licenses compatible with MIT: NumPy/SciPy/pandas (BSD), Pint (BSD), Matplotlib (PSF-based), and openpyxl (MIT). See pyproject.toml for the declared dependency set and CONTRIBUTING.md for the scientific contribution policy.

Download files

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

Source Distribution

tpxlab-0.2.2.tar.gz (507.0 kB view details)

Uploaded Source

Built Distribution

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

tpxlab-0.2.2-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

Details for the file tpxlab-0.2.2.tar.gz.

File metadata

  • Download URL: tpxlab-0.2.2.tar.gz
  • Upload date:
  • Size: 507.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for tpxlab-0.2.2.tar.gz
Algorithm Hash digest
SHA256 946665802f8a8b8d55465a867ca32d98e0c06ec6dff27ebf137356d2d1151e5b
MD5 2d1aeb7dcee27ce356f1b879face93ec
BLAKE2b-256 8c59cd1bd7c12ada45c7c186f79c3dacd1c846e8ba80e0842bf760970f8ffa20

See more details on using hashes here.

Provenance

The following attestation bundles were made for tpxlab-0.2.2.tar.gz:

Publisher: release.yml on hdkim99/TPxLab

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

File details

Details for the file tpxlab-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: tpxlab-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 41.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for tpxlab-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0352da5b70559ded3d2ad9e9aeab8d820bf7ecd692334d22ab15be20c6dffb66
MD5 ee4af2eb37133104e9a36798f2e1748c
BLAKE2b-256 d56713e05b7639a5ae11e32139a7084d228b93bbd9983631e70b627960fd6410

See more details on using hashes here.

Provenance

The following attestation bundles were made for tpxlab-0.2.2-py3-none-any.whl:

Publisher: release.yml on hdkim99/TPxLab

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

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 files

0.2.1

2 files

0.2.0

2 files

Supported by

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