/FlowUtils

FlowUtils is a Python package containing various utility functions related to flow cytometry analysis, primarily focused on compensation and transformation tasks commonly used within the flow community.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

FlowUtils

PyPI license PyPI pyversions PyPI version DOI

Build & test (master) Build & test (develop) Coverage Documentation Status

FlowUtils is a Python package containing various utility functions related to flow cytometry analysis, primarily focused on compensation, transformation, and gating tasks commonly used within the flow community.

FlowUtils is part of a suite of Python libraries for analyzing flow cytometry data. It was developed as an extension to the light-weight FlowIO library. FlowIO reads and writes Flow Cytometry Standard (FCS) files, and has zero dependencies. For higher level interaction with flow cytometry data, including GatingML & FlowJo 10 support, see the related FlowKit project.

Installation

FlowUtils uses C extensions for significant performance improvements. For the most common platforms and Python versions, pre-built binaries are available in PyPI (and installable via pip). If a pre-built binary of FlowUtils is not available for your environment, then the C extensions must be compiled using the source package.

From PyPI

pip install flowutils

From GitHub source code

git clone https://github.com/whitews/flowutils
cd flowutils
pip install .

Documentation

API Documentation is available here.