Skip to content

Commit 3880a63

Browse files
committed
update README
1 parent dc6b7ff commit 3880a63

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@
1414

1515
## Overview
1616

17-
FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS)
18-
files, with minimal dependencies and is compatible with Python 3.9+.
19-
20-
For higher level interaction with flow cytometry data, including GatingML and FlowJo 10 support,
21-
see the related [FlowKit](https://github.com/whitews/FlowKit) project.
17+
FlowIO is a Python library for reading and writing Flow Cytometry Standard (FCS)
18+
files, with minimal dependencies and is compatible with Python 3.9+. It is intended
19+
as a lightweight library, suitable for parsing FCS data sets (e.g. as a web server
20+
backend, for simple metadata extraction, etc.). It is **highly recommended** that
21+
one be familiar with the various FCS file standards (2.0, 3.0, 3,1) before using
22+
FlowIO for downstream analysis. For higher level cytometry analysis, please see the
23+
related [FlowKit](https://github.com/whitews/FlowKit) library which offers a much
24+
wider set of analysis options such as compensation, transformation, and gating
25+
support (including support for importing FlowJo 10 workspaces).
26+
27+
If you have any questions about FlowIO, find any bugs, or feel something is missing
28+
from the documentation [please submit an issue to the GitHub repository here](https://github.com/whitews/FlowIO/issues/new/).
2229

2330
## Installation
2431

0 commit comments

Comments
 (0)