Skip to main content

Peak integration software.

Project description

ChromatoPy Logo

chromatoPy (1.9.0)

chromatoPy is an open-source Python package designed to streamline the integration and analysis of High-Performance Liquid Chromatography (HPLC) and Gas Chromatograph Flame Ionization Detector (GC-FID) data. It features flexible multi-Gaussian and single Gaussian fitting algorithms to detect, fit, and integrate peaks from chromatographic data, enabling efficient analysis and processing of complex datasets. Note, interactive integration requires internal spike standard (Trace 744).

Features

  • Flexible Gaussian Fitting: Supports both single and multi-Gaussian peak fitting algorithms. -- Fit Uncertainty: An ensemble peak areas are calculated using uncertainty in fitting parameters (peak width, height, and centre).
  • Data Integration: Integrates chromatographic peak data for precise quantification.
  • Customizable Analysis: Allows for the adjustment of fitting parameters to accommodate various peak shapes.
  • Input Support: Works with HPLC data converted to .csv format using a built in function that utilizes the package "rainbow".

Installation

To install chromatoPy from the GitHub repository, you can use the following pip command:

pip install chromatopy

Requirements

  • Python 3.12.4 or higher
  • Dependencies are automatically installed when you install the package:
  • numpy==1.26.4
  • pandas==2.2.2
  • scikit-learn==1.4.2
  • scipy==1.13.1
  • matplotlib==3.8.4
  • rainbow-api==1.0.9
  • pybaselines==1.1.0
  • tqdm

Note on Development and Testing

This package has been developed and tested using the Spyder IDE. While it is expected to work in other development environments, it has not been specifically tested with other IDEs. If you encounter any issues when using the package in a different environment, please feel free to raise an issue or reach out for support.

Usage

Once installed, you can start using chromatoPy to analyze your HPLC and GC-FID chromatographic data. Below is a basic example demonstrating how to use the package to load and analyze data:

Example

import chromatopy

# Convert chromatography data to .csv files
chromatopy.hplc_to_csv()

# Run interactive analyzer
chromatopy.hplc_integration()

# Calculate and assign indices
chromatopy.assign_indices()

# Run FID integration
chromatopy.FID_integration()

Input Data Requirements

chromatoPy expects HPLC data to be in .csv format. You can convert your raw HPLC results using the hplc_to_csv() function. FID data are assumed to derive from the software Chromeleon (i.e. a .txt file with raw data following the line "Chromatogram Data Information:"

Versioning

Version numbers are reported in an "X.Y.Z" format.

  • X (Major version): changes that would require the user to adapt their usage of the package (e.g., removing or renaming functions or methods, introducing new functions that change functionality).
  • Y (Minor version): modifications to functions or new features that are backward-compatible.
  • Z (Patch version): minor bug fixes or enhancements that do not affect the core interface/method.

Contributing

Contributions to chromatoPy are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions or inquiries, please contact:

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

chromatopy-1.9.0.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

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

chromatopy-1.9.0-py3-none-any.whl (50.1 kB view details)

Uploaded Python 3

File details

Details for the file chromatopy-1.9.0.tar.gz.

File metadata

  • Download URL: chromatopy-1.9.0.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for chromatopy-1.9.0.tar.gz
Algorithm Hash digest
SHA256 325e8c8fcf462d1071408f0043f831f67ae5bf62a2202d7fc697ef83f95c9ee2
MD5 013c44de49054e6b8c698f018b5f2390
BLAKE2b-256 30e4d7976aac36d81b3555d41739631bfd563704284eb3b6e744d9f9793bd50a

See more details on using hashes here.

File details

Details for the file chromatopy-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: chromatopy-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 50.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for chromatopy-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a798b5a2677b4ce6c9ce90edf070f960c9e2e51604eab51614fc9a0668bcb9bf
MD5 a942a75d10cbe1beb05c0f356a67ef40
BLAKE2b-256 33c9a9aa8182dc7a11c39556a3096c2b8f6cb53903b3481f4f11ca963799342b

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