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.11, 3.12, 3.13 and 3.14.

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.8.0.tar.gz (209.6 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.8.0-py3-none-any.whl (231.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scportrait-1.8.0.tar.gz
Algorithm Hash digest
SHA256 99e3621fd53f2f434a116c28bee616e443fd65e09922ca90830d2235713915d6
MD5 5a9d87b5d2e60609a9fd2486075efa6c
BLAKE2b-256 d2d5918e2764047435e4b1c2a79066f33b30a2561085207ad4473f1c996cccee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scportrait-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 231.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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 15c1beaa4b287d3d28f34eeb1837481b574e00d264a612e6e1d6be2432df85b9
MD5 b67cdd596dc7a86395e7df9e9727cd65
BLAKE2b-256 9bf77b136e7a3f29787567d45e38a3e568153b1b45271439a29b4261669cab8b

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