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.6.1.tar.gz (194.5 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.6.1-py3-none-any.whl (216.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scportrait-1.6.1.tar.gz
Algorithm Hash digest
SHA256 32f55ba03f767865988d7a454dcfe2a7b271549e0d1e92cb3a899fab446f8b56
MD5 b294019e7bd53c74fe8aaf0d1947a527
BLAKE2b-256 f5ef0deecdd3d502b9755457a295536db0dd3914fa2cd98a5486981f8b01d340

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scportrait-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d10a51ae89fae2ea748175a6ac3d3c47590c0f515ccfa8257d1e80b67f2c6466
MD5 b0a685a38910df9ccf1401c11df8c1b2
BLAKE2b-256 4fa3182126904ce1c84c8ebe0834ce904e2c3c6f19f44f66cbb3b70280c86310

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