https://github.com/whitews/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.
https://github.com/whitews/flowutils

cytometry fcs fcs-files flow flow-cytometry flow-cytometry-analysis flow-cytometry-data python

Last synced: 11 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/whitews/flowutils
• Owner: whitews
• License: bsd-3-clause
• Created: 2013-12-12T20:34:38.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2025-06-19T03:20:04.000Z (12 months ago)
• Last Synced: 2025-07-20T05:52:22.919Z (11 months ago)
• Topics: cytometry, fcs, fcs-files, flow, flow-cytometry, flow-cytometry-analysis, flow-cytometry-data, python
• Language: Python
• Homepage: https://flowutils.readthedocs.io
• Size: 6.66 MB
• Stars: 17
• Watchers: 3
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FlowUtils

[![PyPI license](https://img.shields.io/pypi/l/flowutils.svg?colorB=dodgerblue)](https://pypi.python.org/pypi/flowutils/)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/flowutils.svg)](https://pypi.python.org/pypi/flowutils/)

[![PyPI version](https://img.shields.io/pypi/v/flowutils.svg?colorB=blue)](https://pypi.python.org/pypi/flowutils/)

[![DOI](https://zenodo.org/badge/15146734.svg)](https://zenodo.org/badge/latestdoi/15146734)

[![Build & test (master)](https://github.com/whitews/FlowUtils/actions/workflows/tests_master.yml/badge.svg)](https://github.com/whitews/FlowUtils/actions/workflows/tests_master.yml)

[![Build & test (develop)](https://github.com/whitews/FlowUtils/actions/workflows/tests_develop.yml/badge.svg)](https://github.com/whitews/FlowUtils/actions/workflows/tests_develop.yml)

[![Coverage](https://codecov.io/gh/whitews/FlowUtils/branch/master/graph/badge.svg)](https://codecov.io/gh/whitews/flowutils)

[![Documentation Status](https://readthedocs.org/projects/flowutils/badge/?version=latest)](https://flowutils.readthedocs.io/en/latest/?badge=latest)

FlowUtils is a Python package containing 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](https://github.com/whitews/FlowIO). FlowIO reads and 

writes Flow Cytometry Standard (FCS) files, and has minimal dependencies. 

For higher level interaction with flow cytometry data, including GatingML 

& FlowJo 10 support, see the related 

[FlowKit project](https://github.com/whitews/FlowKit).

## 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.](https://flowutils.readthedocs.io/en/latest/?badge=latest)