Skip to main content

A Python package for the inteRactive and Integrated analySis of Multiplexed tissue microarrays

Project description

PRISM: A Python package for the inteRactive and Integrated analySis of Multiplexed tissue microarrays

License MIT PyPI Python Version tests codecov napari hub

NOTE: PRISM is still in heavy development. PRISM or napari-prism is a package and napari plugin designed for interactive processing, analysing and visualising multiplxed tissue microarrays.

Currently, end-to-end capabilities (i.e. starting from importing the raw image file, to basic spatial analysis of annotated cells) are available for images generated from the Akoya Phenocycler™-Fusion platform. However, the modular structure of the package allows for usage at any stage of processing and/or analysis, given a pre-built SpatialData object using readers from either spatialdata-io or sopa.

PRISM uses spatialdata as the core data framework, allowing for:

  1. The rich integration of tools from the (scverse) Python bioinformatics ecosystem with highly interactive graphical user interfaces from napari and napari-spatialdata.
  2. The storage of images, shapes, annotations and their linked AnnData objects in a standardized, FAIR-compliant data structure, addressing the non-standard and fragmented organization of files before, during, and after a multiplexed image analysis pipeline.

The package was designed to be used completely within the napari application and therefore require little to no knowledge of Python programming. Therefore, documentation for usage via the API is currently in progress.

Installation: CPU only

Install this package via pip:

pip install napari-prism

Install the latest development version:

pip install git+https://github.com/clinicalomx/napari-prism.git@main

Installation: GPU-accelerated

General computations with RAPIDS and rapids-singlecell

General larger scale and/or computationally demanding functions can be accelerated with the NVIDIA RAPIDS suite. We utilise some packages from this suite, as well as the GPU-accelerated implementation of scanpy with rapids-singlecell.

  1. Check and configure the system requirements from RAPIDS.
    • Currently, only Linux distributions (or Windows systems with WSL2) are supported.
    • Install the CUDA12.2 or CUDA12.5 toolkit.
  2. Install the package together with RAPIDS and rapids-singlecell via pip:
pip install napari-prism[gpu] --extra-index-url=https://pypi.nvidia.com

Cell segmentation with Cellpose

To run cellpose on the GPU, install the CUDA version of PyTorch. You may need to remove any installed CPU versions of PyTorch.

Getting Started

To start using napari-prism, please see the tutorials:

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "napari-prism" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Citation

**tba

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

napari_prism-0.1.3.tar.gz (24.2 MB view details)

Uploaded Source

Built Distribution

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

napari_prism-0.1.3-py3-none-any.whl (104.5 kB view details)

Uploaded Python 3

File details

Details for the file napari_prism-0.1.3.tar.gz.

File metadata

  • Download URL: napari_prism-0.1.3.tar.gz
  • Upload date:
  • Size: 24.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for napari_prism-0.1.3.tar.gz
Algorithm Hash digest
SHA256 daeb1b993668d3d64aa2379923e66fcd24427d4e1aa0502d17dfca80259f08cb
MD5 37f0744783b12067142f350e7c5cf565
BLAKE2b-256 677ece745169b9f6e0449b90c62caf041fc85da8453052757e14241b10a12b9f

See more details on using hashes here.

File details

Details for the file napari_prism-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: napari_prism-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 104.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for napari_prism-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 be91975ff9421196b17f236adeaa464d1490eda76135432e3698c14c91a64c26
MD5 62beb5aa317ba8acfa52a61e161a577a
BLAKE2b-256 f57aff18b69a08e6e55e7c9e4a4546bf4a44b282ef79d5d53b0e94c19d6e80bc

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