Skip to main content

A Python package for online gas chromatography.

Project description

ChromStream

pyGCxGC Logo

A Python package for processing on-line gas chromatography data. ChromStream provides tools to parse, analyze, and visualize chromatographic data from various GC systems, and combine it with data from logfiles such as temperature and pressure.

Features

  • Parse chromatographic data from multiple formats:
    • Chromeleon (exported txt)
    • Agilent .d directories
    • Agilent .dx files
  • Access to data at experiment, channel and chromatogram level
  • Quick plotting of chromatograms
  • Small selection of baseline corrections, possibility to use custom ones
  • Integration using a dict of peaks
  • Addition of logfiles

Installation

Installing using pip

pip install ChromStream

Install using uv

If you're using uv for fast Python package management:

uv add ChromStream

Quick Start

Check the Quickstart Notebook to see a full demonstration of the most important features of the package. Here's a simple example of how to set up an experiment, add chromatograms and plot them:

import chromstream as cs

exp = cs.Experiment(name='hello there')
exp.add_chromatogram('path-to-your-chromatogram') #loop over files to add multiple
exp.plot_chromatograms()

To access specific channels:

exp.channels['channel-name'].plot()

For specific chromatograms:

exp.channels['channel-name'].chromatograms[0].plot()

Supported File Formats

ChromStream currently supports parsing data from:

  • Chromeleon software exports (.txt)
  • (software names) (ascii files)
  • simple log files (e.g. exported from labview)

Documentation

  • You can find the full documentation of the package here.

Example Notebooks

Check out the example_notebooks/ directory for comprehensive examples:

  • example_calibration.ipynb - GC calibration procedures

Roadmap

  • Support for more files formats
  • Addition of more data sources such as spectroscopy
  • JSON/HDF5 saving and parsings
  • tests

Contributing

This package is in active development. Any help is appreciated. You can submit feature requests or bug reports as issues on the repository. If you have a specific file format which presently is nto supported please provide an example file. PRs are more than welcome.

Authors

Sebastian Rejman - Fritz-Haber-Institute / Utrecht 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

chromstream-0.1.0.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

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

chromstream-0.1.0-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file chromstream-0.1.0.tar.gz.

File metadata

  • Download URL: chromstream-0.1.0.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for chromstream-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aefde9580007e9f14cb310e5388cd2596ab7364117d2ba698f653335c98449d0
MD5 a433275a71189056eea63e07ea9f7bd4
BLAKE2b-256 a8f2f98fd27075e611380ee92fc7b91f7e7a55aaae6193cf2c823665779de7ef

See more details on using hashes here.

File details

Details for the file chromstream-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: chromstream-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for chromstream-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f987d9eaac56419799571125bf6f2e77f7851ee7293fb9fa064237353a80cebf
MD5 425bc11025e70ce361927074141d6f2e
BLAKE2b-256 c6c647110e74ba3218545e83917ce4cfe8239e41665740c5d8e9c09e5c1dc67f

See more details on using hashes here.

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