Skip to main content

coSMicQC is a software tool for single-cell quality control of morphology datasets.

Project description

Single cell Morphology Quality Control

PyPI - Version Build Status Coverage Status Ruff Poetry Preprint DOI badge Software DOI badge

🌠 Navigate the cosmos of single-cell morphology with confidence — coSMicQC keeps your data on course!

Contents

Overview

coSMicQC is a Python package to evaluate converted single-cell morphology outputs from CytoTable. Technical artifacts can arise during segmentation, leading to issues such as under-segmentation, over-segmentation, or the erroneous segmentation of background noise, smudges, or bright artifacts. By utilizing specific morphological features extracted with CellProfiler, you can identify technically incorrect segmentations and label or remove them before downstream analysis.

Please confer with our docsite for more comprehensive information about the project: https://cytomining.github.io/coSMicQC/main/

🌟 Check out our blog post for a deeper background and how coSMicQC can help.

Repo Contents

  • src/cosmicqc: coSMicQC source code.
  • tests: test suite.
  • docs: documentation sources and examples.
  • media: project assets (e.g., coverage badge).
  • reports: generated artifacts (figures, notebooks, or summaries).

System Requirements

  • Python: >=3.10 (tested through 3.13).
  • RAM/CPU: standard laptop/desktop is sufficient for typical plate-sized datasets; larger screens benefit from more RAM/cores for faster QC/plotting.
  • OS: Linux, macOS, and Windows are supported via Python; CI tests run on GitHub Actions.

Installation Guide

Stable release (PyPI)

pip install coSMicQC

Development version (from source)

pip install git+https://github.com/cytomining/coSMicQC.git
# or with poetry for local development
poetry install --with dev

Demo

Results

  • Test and lint status: Build Status
  • Coverage: Coverage Status

License

BSD-3-Clause; see LICENSE.

Issues

Please open issues or feature requests at https://github.com/cytomining/coSMicQC/issues.

Citation

If you use coSMicQC in your work, please cite:

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

cosmicqc-1.0.3.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cosmicqc-1.0.3-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file cosmicqc-1.0.3.tar.gz.

File metadata

  • Download URL: cosmicqc-1.0.3.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cosmicqc-1.0.3.tar.gz
Algorithm Hash digest
SHA256 a5b991afb1e3d2e2c01d4c5ae0f36df5314ae179b34cc55cacb2429bca54afda
MD5 20421dcbed283df6df38cb92851d1f39
BLAKE2b-256 2bae09979ba4b4996788e4a5240d7f25cbca78b8f94c55d83474fde40811c1eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cosmicqc-1.0.3.tar.gz:

Publisher: publish-pypi.yml on cytomining/coSMicQC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cosmicqc-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: cosmicqc-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cosmicqc-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ec1010276fd1e9aea92fb4d8a8d019bc3b795564c7d2ba7bf5caa0c59b2ef742
MD5 a2b6521c1070fc96999364fce913c6b1
BLAKE2b-256 840002371eaaf6c5fa8afe766f282a96bccdf624389df94b0ba454a88de6c1e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for cosmicqc-1.0.3-py3-none-any.whl:

Publisher: publish-pypi.yml on cytomining/coSMicQC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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