Skip to content

whitews/FlowIO

Repository files navigation

FlowIO

PyPI license PyPI pyversions PyPI version DOI

Test (master) Test (develop) Coverage Documentation Status PyPI - Downloads

Overview

FlowIO is a Python library for reading and writing Flow Cytometry Standard (FCS) files, with minimal dependencies and is compatible with Python 3.9+. It is intended as a lightweight library, suitable for parsing FCS data sets (e.g. as a web server backend, for simple metadata extraction, etc.). For higher level cytometry analysis, please see the related FlowKit library which offers a much wider set of analysis options such as compensation, transformation, and gating support (including support for importing FlowJo 10 workspaces).

If you have any questions about FlowIO, find any bugs, or feel something is missing from the documentation please submit an issue to the GitHub repository here.

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

Changelogs for versions are available here