Metadata-Version: 2.4
Name: chipstream
Version: 0.9.3
Summary: GUI and CLI for DC data postprocessing
Author: Paul Müller
Maintainer-email: Paul Müller <dev@craban.de>
License-Expression: GPL-3.0-or-later
Project-URL: source, https://github.com/DC-Analysis/ChipStream
Project-URL: tracker, https://github.com/DC-Analysis/ChipStream/issues
Project-URL: documentation, https://chipstream.readthedocs.io/en/stable/
Project-URL: changelog, https://chipstream.readthedocs.io/en/stable/sec_changelog.html
Keywords: RT-DC,deformability,cytometry
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Requires-Python: <4,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: dcnum>=0.27.1
Requires-Dist: h5py<4,>=3.0.0
Requires-Dist: numpy<3,>=1.21
Requires-Dist: psutil>=7
Provides-Extra: all
Requires-Dist: chipstream[cli,gui,torch]; extra == "all"
Provides-Extra: cli
Requires-Dist: click>=8.2; extra == "cli"
Provides-Extra: gui
Requires-Dist: pyqt6; extra == "gui"
Provides-Extra: torch
Requires-Dist: torch>=2.2; extra == "torch"
Dynamic: license-file

|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 <https://chipstream.readthedocs.io>`__.


Installation
------------
Installers for Windows and macOS are available at the `release page
<https://github.com/DC-analysis/ChipStream/releases>`__.
The `documentation/install section <https://chipstream.readthedocs.io/en/latest/install.html>`_
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


.. |ChipStream| image:: https://raw.github.com/DC-analysis/ChipStream/main/docs/artwork/chipstream_splash.png
.. |PyPI Version| image:: https://img.shields.io/pypi/v/ChipStream.svg
   :target: https://pypi.python.org/pypi/ChipStream
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DC-analysis/ChipStream/check.yml?branch=main
   :target: https://github.com/DC-analysis/ChipStream/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DC-analysis/ChipStream/main.svg
   :target: https://codecov.io/gh/DC-analysis/ChipStream
.. |Docs Status| image:: https://img.shields.io/readthedocs/chipstream
   :target: https://readthedocs.org/projects/chipstream/builds/
