Skip to content

K-Dense-AI/scientific-agent-skills / skills/flowio

flowio

Verified

Reads, inspects, and writes Flow Cytometry Standard (FCS) 2.0, 3.0, and 3.1 files with FlowIO. Use for low-level FCS metadata and channel inspection, NumPy event extraction, multi-dataset files, table export, and FCS 3.1 creation; use FlowKit for compensation, cytometry transforms, gating, or FlowJo workspaces.

FileKindSize
SKILL.mdskill md13.2 KB
references/api_reference.mdmarkdown12.2 KB
references/fcs_semantics.mdmarkdown10.3 KB
references/sources.mdmarkdown5.7 KB
references/troubleshooting.mdmarkdown11.6 KB
references/workflows.mdmarkdown11.5 KB
scripts/inspect_fcs.pyscript14.7 KB

references/sources.md

View on GitHub
# Authoritative Sources

This skill was refreshed on **2026-09-30** against the sources below. Examples
target the current stable package release at that date: **FlowIO 1.4.0**,
published **2025-05-09**.

When upstream behavior and this skill differ, prefer the tagged upstream source
and official API documentation, then update this skill and increment its
version.

## Package and Release

- [FlowIO on PyPI](https://pypi.org/project/FlowIO/) — stable version, release
  date, supported Python classifiers, dependency metadata, and project links.
- [FlowIO 1.4.0 release notes](https://github.com/whitews/FlowIO/releases/tag/1.4.0)
  — Python 3.13 support, `as_array()`, constructor rename, convenience
  attributes, NumPy dependency, public `fcs_keywords`, `Path` support, and
  writer/timestep changes.
- [All FlowIO releases](https://github.com/whitews/FlowIO/releases) — migration
  and bug-fix history.
- [FlowIO 1.4.0 tagged source](https://github.com/whitews/FlowIO/tree/1.4.0) —
  release-tagged implementation baseline used to verify edge behavior.
- [FlowIO 1.4.0 package metadata](https://github.com/whitews/FlowIO/blob/1.4.0/pyproject.toml)
  — supported Python versions and NumPy dependency.

## Official Documentation and User Guide

- [FlowIO documentation](https://flowio.readthedocs.io/en/latest/) — official
  entry point and installation overview.
- [FlowIO tutorial](https://flowio.readthedocs.io/en/latest/notebooks/flowio_tutorial.html)
  — official 1.4.0 user guide covering FCS segments, metadata, event values,
  export, keyword lists, multiple datasets, creation, and exceptions.
- [FlowIO API](https://flowio.readthedocs.io/en/latest/api.html) — generated
  signatures and public API reference.
- [FlowData 1.4.0 source](https://github.com/whitews/FlowIO/blob/1.4.0/src/flowio/flowdata.py)
  — metadata normalization, offset behavior, event parsing, preprocessing, and
  `write_fcs()`.
- [`create_fcs` 1.4.0 source](https://github.com/whitews/FlowIO/blob/1.4.0/src/flowio/create_fcs.py)
  — writer signature, validation, metadata rules, output representation, and
  float precision.
- [`read_multiple_data_sets` 1.4.0 source](https://github.com/whitews/FlowIO/blob/1.4.0/src/flowio/utils.py)
  — relative `$NEXTDATA` traversal and invalid-offset handling.
- [FlowIO exceptions 1.4.0 source](https://github.com/whitews/FlowIO/blob/1.4.0/src/flowio/exceptions.py)
  — warning and exception hierarchy.

## Flow Cytometry Standard

- Spidlen J, et al. [Data File Standard for Flow Cytometry, version FCS
  3.1](https://pubmed.ncbi.nlm.nih.gov/19937951/). *Cytometry Part A*.
  2010;77A(1):97-100.
  [doi:10.1002/cyto.a.20825](https://doi.org/10.1002/cyto.a.20825)
- Bray C, Spidlen J, Brinkman RR. [FCS 3.1 Implementation
  Guidance](https://pubmed.ncbi.nlm.nih.gov/22278913/). *Cytometry Part A*.
  2012;81(6):523-526.
  [doi:10.1002/cyto.a.22018](https://doi.org/10.1002/cyto.a.22018)
- [Free full text of the FCS 3.1 implementation
  guidance](https://pmc.ncbi.nlm.nih.gov/articles/PMC3676281/) — spillover,
  display, and compatibility guidance.

FlowIO reads FCS 2.0/3.0/3.1 and writes FCS 3.1. The standard publications are
needed when byte offsets, keywords, spillover metadata, or representation
details affect scientific interpretation.

## Array and Table Behavior

- [NumPy mean](https://numpy.org/doc/stable/reference/generated/numpy.mean.html)
  — accumulator dtype and precision; runtime fixtures also checked overflow.
- [pandas duplicate labels](https://pandas.pydata.org/docs/user_guide/duplicates.html)
  — duplicate columns are permitted by default, so exports explicitly create
  unique labels and retain positional source-label provenance.

## Higher-Level Analysis Boundary

- [FlowKit project](https://github.com/whitews/FlowKit) — related package for
  compensation, transformations, gating, GatingML, and FlowJo workspace
  support.
- [FlowKit documentation](https://flowkit.readthedocs.io/en/latest/) — use when
  a task moves beyond low-level FCS I/O.

## Verification Notes

During this refresh:

- PyPI, the latest GitHub release endpoint, and official documentation all
  identified 1.4.0 as the stable release.
- Runtime signatures were checked in an isolated `flowio==1.4.0` environment.
- Read/write behavior was round-tripped with a generated FCS 3.1 file.
- Runtime edge tests covered null-channel storage, literal `$` removal from
  TEXT values, caller-owned handle closure, and PnG/`timestep` loss during
  `write_fcs()`.
- The tagged implementation was used where generated API prose omitted details,
  especially metadata normalization and writer behavior.
- Current checks ran on Python 3.13 with FlowIO 1.4.0, NumPy 2.5.3, and
  pandas 3.0.6 using local synthetic FCS 2.0/3.0/3.1 integer, float, double,
  and multiple-dataset files. No scientific service credentials are needed.
- FlowIO reads DATA without enforcing the declared `$TOT`; the inspector now
  checks loaded value count before `as_array()`. Integer range masking occurs
  before optional preprocessing, and recognized Time-channel gain is forced
  to one. Tagged source and independent binary fixtures verify these details.
- Generated DataFrame names now avoid collisions with existing suffixed names;
  extreme finite doubles no longer overflow the inspector's mean calculation.
- The inspector rejects unsupported mode/type metadata and reports truncated
  DATA parsing failures cleanly. Its limits are not a process-memory sandbox.
- This is local file-format functionality, not a hosted API. There are no
  runtime HTTP endpoints, authentication, pagination, or paid service calls.
- Big-endian writer portability remains unverified. The 1.4.0 writer declares
  little-endian output while using Python's native-endian `array('f')` bytes;
  validate exports on big-endian hardware rather than assuming portability.
slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 198kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall