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.5.1.tar.gz (190.1 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.5.1-py3-none-any.whl (211.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scportrait-1.5.1.tar.gz
Algorithm Hash digest
SHA256 26bfd5584f6fa24182d196908874d59ebd8e3113e3f254e560040729cb45eeb1
MD5 0e2e0295481ebb196c91369fe34f8138
BLAKE2b-256 4ffb22d0657ba46048fea9d4bae87d5b082d74a5252979f576308566e4b7ab03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scportrait-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 211.4 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b204cf47ded8d40e4e7a5557ae7a93ffe1b71d8d4ab5cdbcab58fecc93949ea0
MD5 4ab16e44e903cfa5b1f3f87ab844b220
BLAKE2b-256 0e0b3493848039f61eea60c63a10bd4800cc093c61f0e805482e99e6d9a2b522

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