Skip to main content

GUI and CLI for DC data postprocessing

Project description

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.

If you have Python installed, you can install ChipStream from PyPI

# graphical user interface
pip install chipstream[gui]
# command-line interface
pip install chipstream[cli]
# both
pip install chipstream[cli,gui]

Since version 0.6.0, you can also make use of torch-based segmentation models.

pip install chipstream[cli,gui,torch]

If you have a CUDA-compatible GPU and your Python installation cannot access the GPU (torch.cuda.is_available() is False), please use the installation instructions from pytorch (https://pytorch.org/get-started/locally/). For instance, if you have CUDA 12.1, you can install torch with this pytorch.org index URL:

pip install torch torchvision --index-url https://download.pytorch.org/whl/cu121

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chipstream-0.6.3.tar.gz (428.7 kB view details)

Uploaded Source

Built Distribution

chipstream-0.6.3-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

Details for the file chipstream-0.6.3.tar.gz.

File metadata

  • Download URL: chipstream-0.6.3.tar.gz
  • Upload date:
  • Size: 428.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for chipstream-0.6.3.tar.gz
Algorithm Hash digest
SHA256 2857cd887cfa106e4bcd2cdd899c48ddc0d7afc67027020badcb0a4ed01c2685
MD5 702c606d48a695e3b8fe4ffd8a9faa9c
BLAKE2b-256 dfc773fcc065f484c032d6958b3970ebbcbb544b34a40ff929da88c8a06ef00e

See more details on using hashes here.

File details

Details for the file chipstream-0.6.3-py3-none-any.whl.

File metadata

  • Download URL: chipstream-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 54.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for chipstream-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 68aaf2c40e3cf5f57468f22229c05ec6317e1ce63650bf33b6ddf8ec9c0e4a86
MD5 90b308cbd0d433f7709eb40664988b73
BLAKE2b-256 78d50f165ee51d52a155797c87f31327e3ec12ad3b12ed1506ad965858cf295f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page