Skip to content

DC-analysis/ChipStream

Repository files navigation

ChipStream

PyPI Version Build Status Coverage Status Docs Status

ChipStream is a graphical user interface for postprocessing deformability cytometry (DC) data. This includes background computation, event segmentation, and feature extraction.

Documentation

The documentation, is available at chipstream.readthedocs.io.

Installation

Installers for Windows and macOS are available at the release page. The documentation/install section explains how you can install ChipStream via pip, including extras and caveats.

Execution

If you have installed ChipStream from PyPI, you can start it with

# graphical user interface
chipstream-gui
# command-line interface
chipstream-cli

Citing ChipStream

Please cite ChipStream either in-line

(...) using the postprocessing software ChipStream version X.X.X
(available at https://github.com/DC-analysis/ChipStream).

or in a bibliography

Paul Müller and others (2023), ChipStream version X.X.X: Postprocessing
software for deformability cytometry [Software]. Available at
https://github.com/DC-analysis/ChipStream.

and replace X.X.X with the version of ChipStream that you used.

Testing

pip install -e .
pip install -r tests/requirements.txt
pytest tests

About

GUI and CLI for DC data postprocessing (background computation, segmentation, feature extraction)

Resources

License

Stars

Watchers

Forks

Packages

No packages published