FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS) files
Project description
FlowIO
Overview
FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS) files, with zero external dependencies and is compatible with Python 3.7+.
FlowIO retrieves event data exactly as it is encoded in the FCS file: as a 1-dimensional list without separating the events into channels or performing any preprocessing (e.g. applying gain). Metadata stored in the FCS file is available as a dictionary via the 'text' attribute. Basic attributes are also available for commonly accessed properties. For example, the channel count can be used to easily convert the event data to a multi-column NumPy array:
import flowio
import numpy
fcs_data = flowio.FlowData('example.fcs')
npy_data = numpy.reshape(fcs_data.events, (-1, fcs_data.channel_count))
For higher level interaction with flow cytometry data, including GatingML and FlowJo 10 support, see the related FlowKit project.
Installation
The recommended way to install FlowIO is via the pip
command:
pip install flowio
Or, if you prefer, you can install from the GitHub source:
git clone https://github.com/whitews/flowio
cd flowio
pip install .
Documentation
The FlowIO API documentation is available on ReadTheDocs here. If you have any questions about FlowIO or find any bugs please submit an issue to the GitHub repository here.
Changelogs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file FlowIO-1.3.0.tar.gz
.
File metadata
- Download URL: FlowIO-1.3.0.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf72b317a0433dca4ce7de6dd76a1f58db27a61ca2021f554ba4014b3149d00b |
|
MD5 | e5a62a9cc0feb573d4787c6375c39530 |
|
BLAKE2b-256 | 573b75fd3227f1c4dded24f228906428aac384c0917028cc0ec325e2855418e0 |