Skip to main content

FlowIO

PyPI license PyPI pyversions PyPI version DOI

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

Overview

FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS) files and has zero external dependencies. FlowIO is compatible with Python 3.7+ (FlowIO v0.9.9 was the last release supporting Python 2).

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). However, all the 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
python setup.py 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

Metadata

Release files for FlowIO 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for FlowIO 1.1.1
File Size Uploaded
FlowIO-1.1.1.tar.gz 14.4 kB Details

Release files / FlowIO-1.1.1.tar.gz

Download URL FlowIO-1.1.1.tar.gz
Size 14.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6a2ff66c10a312bc0fc0949775064d64d4896efdd67c391e60c2b837952b25b6
BLAKE2b-256 checksum
How to use checksums
2cdfe42c7c9a7106b1bd6fcac47ccc47ba52c7c43565fa6cc1870dcf27b5f1ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release history Release notifications | RSS feed

1.4.0

1 release file

1.3.0

1 release file

1.2.1

1 release file

1.2.0

1 release file

This release

1.1.1 This release

1 release file

1.1.0

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.9.14

1 release file

0.9.13

2 release files

0.9.11

2 release files

0.9.9

2 release files

0.9.8

2 release files

0.9.7

2 release files

0.9.6

2 release files

0.9.5

2 release files

0.9.4

2 release files

0.9.3

2 release files

0.9

2 release files

0.8

2 release files

0.7

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page