Skip to main content

Read chromatography and mass spectrometry binary files

Project description

rainbow

PyPI version Documentation Status Language grade: Python

rainbow provides programmatic access to the raw data encoded in chromatography and mass spectrometry binary files. This library supports the following vendors and detectors:

Agilent .D

  • .uv - UV spectrum (supports incomplete files)
  • .ch - UV, FID, CAD, and ELSD channels
  • .ms - MS (supports incomplete files)
  • MSProfile.bin - HRMS

Waters .raw

  • CHRO - CAD and ELSD, as well as miscellaneous analog data
  • FUNC - UV and MS

There is documentation for rainbow that also details the structure of each binary file format.

Installation

pip install rainbow-api

Usage

The easiest way to get started is to give rainbow a directory path. Assume that we have a directory mydata.D that contains a binary file DAD1.uv with UV data.

import rainbow as rb
datadir = rb.read("mydata.D")
datafile = datadir.get_file("DAD1A.uv")

Here, the datadir DataDirectory object contains a DataFile object for DAD1A.uv. The raw UV data is contained in numpy arrays that are attributes of datafile. Users may find the following particularly useful:

  • datafile.xlabels - 1D numpy array with retention times
  • datafile.ylabels - 1D numpy array with wavelengths
  • datafile.data - 2D numpy array with absorbances

There is a tutorial available. There are also example snippets for basic tasks. Or just check out the full API.

Contents

  • rainbow/ contains the code of the Python library.
  • docs/ contains code for generating documentation. To build documentation locally, you will need to install the sphinx and sphinx-rtd-theme packages. Then, move to the docs/ directory and run make html. The docpages will be generated under docs/_build.
  • tests/ contains unit tests for the library. These can be run with python -m unittest.

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

rainbow-api-1.0.0.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

rainbow_api-1.0.0-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file rainbow-api-1.0.0.tar.gz.

File metadata

  • Download URL: rainbow-api-1.0.0.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for rainbow-api-1.0.0.tar.gz
Algorithm Hash digest
SHA256 805cbea4fe8e9acbbf01583efa76db27c880e52e28a31e881f5ce970c95026f4
MD5 a7606492540177ea2e3a5dd9812928c3
BLAKE2b-256 d0e1d5649cedbb6fb3729ec3301afccfd3a9ddd25a6931b4fdd00b4e02687279

See more details on using hashes here.

File details

Details for the file rainbow_api-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: rainbow_api-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for rainbow_api-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b57c76f2749c0bf94223d5fc6146ce1ec5036de917efb66c7182b19760f962d1
MD5 243b9c4f6413ffd63c02a4352e2da1af
BLAKE2b-256 5ab1e50fcde65e7cef6ef1ede549752c28b1521017cd3c60f541951002ca41be

See more details on using hashes here.

Supported by

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