Skip to main content

A Python package description goes here.

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, FID, etc.)
  • 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 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 - 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.0.1.tar.gz (20.7 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.0.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chromstream-0.0.1.tar.gz
Algorithm Hash digest
SHA256 269627dd87e093f756fb7431c744583048f4989e42d7f1b3cba34e372c29a00b
MD5 2e5b306827174f93084fd2ecf1847173
BLAKE2b-256 b713751c0dec027d6549a5991aa470660e7d8d01791a6a4410c4da6a444496d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chromstream-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 17.1 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 69d958986e07e33272a17d215d54ff8d1f1539388cbf83e56cddc4f8a00466d0
MD5 970aaa7e2d9ac419a6e434445ea1e0dc
BLAKE2b-256 73f9315443ea420f83be8ef0bf9ab194bbe7e50a990dde773d70db79f5bc0e55

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