Skip to main content

Computational framework to generate single cell datasets from raw microscopy images.

Project description

GitHub Release Versions License Docs Unit Tests E2E Tests pre-commit.ci status PyPI version PyPI Downloads

graphical_abstract

scPortrait is a scalable toolkit to generate single-cell representations from raw microscopy images.

Getting started

Please refer to our documentation, in particular:

Installation from Github

Check out the docs for complete installation instructions. scPortrait currently supports Python 3.10, 3.11 and 3.12.

To get started you can install scPortrait via pip:

pip install scportrait

Limitations

Currently the scPortrait framework is being developed using Linux and macOS, and only provides limited Windows support. Please refer to this GitHub issue for more information.

Citing our Work

scPortrait was created by Sophia Mädler, Niklas Schmacke and Georg Wallmann in the labs of Matthias Mann, Veit Hornung and Fabian Theis in 2024 and is actively being developed. If you are interested in contributing please reach out to the developers.

If you use our code please cite this manuscript:

scPortrait integrates single-cell images into multimodal modeling. Sophia Clara Mädler, Niklas Arndt Schmacke, Alessandro Palma, Altana Namsaraeva, Ali Oğuz Can, Varvara Varlamova, Lukas Heumos, Mahima Arunkumar, Georg Wallmann, Veit Hornung, Fabian J. Theis, Matthias Mann
https://www.biorxiv.org/content/10.1101/2025.09.22.677590v1

Contributing

If you like this software, consider giving us a star to boost our visibility! For detailed guidelines on how to contribute, please refer to our contributing guide.

We welcome all types of contributions! You can:

  • Post a new issue if you encounter a bug or have a feature request.
  • Clone the repository, create a new branch, and submit a pull request.
  • Join the conversation in our discussions for more interactive participation.

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

scportrait-1.7.0.tar.gz (207.8 kB view details)

Uploaded Source

Built Distribution

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

scportrait-1.7.0-py3-none-any.whl (229.7 kB view details)

Uploaded Python 3

File details

Details for the file scportrait-1.7.0.tar.gz.

File metadata

  • Download URL: scportrait-1.7.0.tar.gz
  • Upload date:
  • Size: 207.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scportrait-1.7.0.tar.gz
Algorithm Hash digest
SHA256 7a40d46580942fff1cc964963e9b022f17aa38214ffa0a84823c35de068663da
MD5 d1509f2c2b71c54b18f71ce3d648061b
BLAKE2b-256 41efac63880aab4c6f75e7edf1821dd07abaa18fc0c400b691620682f98dffd1

See more details on using hashes here.

File details

Details for the file scportrait-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: scportrait-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 229.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scportrait-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 002466c825a128132a2cce1ff84aa569108f73de9887d9be459c53e4f8bc1f9c
MD5 3fb11de222fcfce327009f3302c16aaf
BLAKE2b-256 1017827f9de74de09d068c2f5353d3a717d260a0bf903b240dba628d648b6c74

See more details on using hashes here.

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