Repository files navigation

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 a1-dimensional list without separating the events into channels or performingany preprocessing (e.g. applying gain). Metadata stored in the FCS file isavailable as a dictionary via the 'text' attribute. Basic attributes are alsoavailable for commonly accessed properties. For example, the channel countcan be used to easily convert the event data to a multi-column NumPy array:

import flowioimport numpyfcs_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 relatedFlowKit project.

The recommended way to install FlowIO is via thepip command:

pip install flowio

Or, if you prefer, you can install from the GitHub source:

git clone https://github.com/whitews/flowiocd flowiopip install .

The FlowIO API documentation is availableon ReadTheDocs here. If you have any questions about FlowIO or find any bugsplease submit an issue to the GitHub repository here.

Changelogs for versions are available here