|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/
Raw data
{
"_id": null,
"home_page": null,
"name": "chipstream",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": "Paul M\u00fcller <dev@craban.de>",
"keywords": "RT-DC, deformability, cytometry",
"author": "Paul M\u00fcller",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/74/aa/2f4e9cd6878062b666e8c32325b4b0fbd77c03488776979864d29bb2b551/chipstream-0.8.0.tar.gz",
"platform": null,
"description": "|ChipStream|\n============\n\n|PyPI Version| |Build Status| |Coverage Status| |Docs Status|\n\n\n**ChipStream** is a graphical user interface for postprocessing\ndeformability cytometry (DC) data. This includes background computation,\nevent segmentation, and feature extraction.\n\n\nDocumentation\n-------------\n\nThe documentation, is available at\n`chipstream.readthedocs.io <https://chipstream.readthedocs.io>`__.\n\n\nInstallation\n------------\nInstallers for Windows and macOS are available at the `release page\n<https://github.com/DC-analysis/ChipStream/releases>`__.\nThe `documentation/install section <https://chipstream.readthedocs.io/en/latest/install.html>`_\nexplains how you can install ChipStream via ``pip``, including extras and caveats.\n\n\nExecution\n---------\nIf you have installed ChipStream from PyPI, you can start it with\n\n::\n\n # graphical user interface\n chipstream-gui\n # command-line interface\n chipstream-cli\n\n\nCiting ChipStream\n-----------------\nPlease cite ChipStream either in-line\n\n::\n\n (...) using the postprocessing software ChipStream version X.X.X\n (available at https://github.com/DC-analysis/ChipStream).\n\nor in a bibliography\n\n::\n\n Paul M\u00fcller and others (2023), ChipStream version X.X.X: Postprocessing\n software for deformability cytometry [Software]. Available at\n https://github.com/DC-analysis/ChipStream.\n\nand replace ``X.X.X`` with the version of ChipStream that you used.\n\n\nTesting\n-------\n\n::\n\n pip install -e .\n pip install -r tests/requirements.txt\n pytest tests\n\n\n.. |ChipStream| image:: https://raw.github.com/DC-analysis/ChipStream/main/docs/artwork/chipstream_splash.png\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/ChipStream.svg\n :target: https://pypi.python.org/pypi/ChipStream\n.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DC-analysis/ChipStream/check.yml?branch=main\n :target: https://github.com/DC-analysis/ChipStream/actions?query=workflow%3AChecks\n.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DC-analysis/ChipStream/main.svg\n :target: https://codecov.io/gh/DC-analysis/ChipStream\n.. |Docs Status| image:: https://img.shields.io/readthedocs/chipstream\n :target: https://readthedocs.org/projects/chipstream/builds/\n",
"bugtrack_url": null,
"license": null,
"summary": "GUI and CLI for DC data postprocessing",
"version": "0.8.0",
"project_urls": {
"changelog": "https://chipstream.readthedocs.io/en/stable/sec_changelog.html",
"documentation": "https://chipstream.readthedocs.io/en/stable/",
"source": "https://github.com/DC-Analysis/ChipStream",
"tracker": "https://github.com/DC-Analysis/ChipStream/issues"
},
"split_keywords": [
"rt-dc",
" deformability",
" cytometry"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ca7c4c278b5e3acaa43e005dbb18b25846fc287560e2430c1a7e64b76d15c420",
"md5": "0ae109197277ed2b70181b144d0e5268",
"sha256": "739f7f15c83351790e9800cda1ef96ef864591d8bfccc56528a4f6d03da0561c"
},
"downloads": -1,
"filename": "chipstream-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ae109197277ed2b70181b144d0e5268",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 54950,
"upload_time": "2025-08-07T23:25:32",
"upload_time_iso_8601": "2025-08-07T23:25:32.716539Z",
"url": "https://files.pythonhosted.org/packages/ca/7c/4c278b5e3acaa43e005dbb18b25846fc287560e2430c1a7e64b76d15c420/chipstream-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "74aa2f4e9cd6878062b666e8c32325b4b0fbd77c03488776979864d29bb2b551",
"md5": "762aaf6e13be5c35400c411c0f698dee",
"sha256": "5a99fbb89adaa9621c4f97e7d501b650313b8e9980030738782a1d5ae4294c77"
},
"downloads": -1,
"filename": "chipstream-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "762aaf6e13be5c35400c411c0f698dee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 429489,
"upload_time": "2025-08-07T23:25:34",
"upload_time_iso_8601": "2025-08-07T23:25:34.065218Z",
"url": "https://files.pythonhosted.org/packages/74/aa/2f4e9cd6878062b666e8c32325b4b0fbd77c03488776979864d29bb2b551/chipstream-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 23:25:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DC-Analysis",
"github_project": "ChipStream",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chipstream"
}
JSON
