FlowCytometryTools 0.3.6

Who is this for?

FlowCytometryTools is for researchers who want to use the python programming language to analyze flow cytometry data.

The package provides an interface that can directly work with collections of flow cytometry measurements (e.g., 96-well plates).

Basic familiarity with the python programming languages is recommended.

You can find a few example scripts that load and plot flow cytometry data in the gallery page.

If you like what you see, then proceed to the installation page and then to the tutorial.

Features

• Transformations: hyperlog (hlog), truncated log (tlog)

• Plotting: 1D, 2D histograms for both single samples and collections (e.g., 96-well plates).

• Gating: threshold, interval, quad, polygon gates

• GUI: simple graphical user interface to draw gates

• FCS Formats: Supports FCS 2.0, 3.0, and 3.1

Note: Compensation matrices are not yet read from FCS files, so currently compensation needs to be done manually.

Resources

• Documentation: http://gorelab.bitbucket.org/flowcytometrytools/

• Source Repository: https://bitbucket.org/gorelab/flowcytometrytools

• Comments or questions: https://bitbucket.org/gorelab/flowcytometrytools/issues

Dependencies

For more information about how to obtain these, please see the installation page.

FlowCytometryTools may work with older versions of some of these dependencies, but if you run into issues, please update the dependencies.

Required Dependencies

1. python : 2.6 or 2.7 (note that python 3.0 or higher are not yet supported!)

2. pandas (Recommended version: 0.12.0 or higher).

3. matplotlib: (Recommended version: 1.13.1 or higher).

4. scipy

Optional Dependencies

1. wx-python : Used for the FlowCytometryTools GUI.

LICENSE

The MIT License (MIT)

Copyright (c) 2013-2014 Eugene Yurtsev and Jonathan Friedman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.