Skip to main content

Plexora

Plexora is a viewer for multiplexed imaging and spatial transcriptomics. It opens large images where they are, without converting or copying them, draws segmentation masks and cell tables over them, and runs on a laptop, in a notebook, on a remote workstation or on an HPC cluster.

Documentation: https://nirmallab.github.io/plexora/

The Plexora viewer showing a multiplexed tissue image

Install

pip install plexora
plexora

plexora starts the viewer and opens it in your browser. Python 3.12 or 3.13 is required. A desktop app for macOS, Windows and Linux is on the releases page. See Installation.

Quick start

In the app, choose File → Import Sample… and pick an image, a folder of files, or a Xenium or Visium run. From Python:

import plexora

name = plexora.import_sample("slide.ome.tif", "slide_mask.tif", "cells.csv", wait=True)
plexora.view(name)   # in a notebook, shows the viewer inline

More in the quick start.

What it reads

  • Multiplexed images: OME-TIFF, TIFF, QPTIFF, OME-Zarr (local, https:// or s3://)
  • Brightfield whole-slide images: SVS, NDPI, SCN, BIF, MRXS, DICOM
  • 10x Genomics Xenium, Visium and Visium HD output folders
  • SpatialData stores and AnnData tables; CSV, TSV and Parquet cell tables
  • Segmentation masks (label images) and cell boundary polygons

The full list is in Supported formats.

Where to go next

I want to Read
Use the viewer and its tools Viewer, Tools
Script it from Python or a notebook Python, Notebooks
Look at data on a remote machine or cluster Remote and HPC
Write a plugin Plugin development
Look up a function or command Python API, Command line

Developing Plexora

git clone https://github.com/nirmallab/plexora.git
cd plexora
pip install -e ".[dev]"
python -m pytest -q -p no:randomly

See Development setup and, for the documentation site in website/, CONTRIBUTING_DOCS.md. Engineering notes live in docs/internal/.

Usage data

Plexora can send anonymous usage counts -- which features and plugins are used, how long tiles take to draw, which kinds of errors occur -- so we know what to improve. It never sends file, project, marker or gene names, cell data, coordinates, usernames, machine names, paths, prompts or anything typed into a tool; every field it may send is on an allowlist (plexora/telemetry/schema.py). Everything is queued on this machine first, nothing in Plexora waits for it, and it works air-gapped exactly as before.

It is on by default and a notice says so the first time. Any one of these turns it off:

plexora telemetry off        # or: Settings > Usage data
export DO_NOT_TRACK=1        # honoured everywhere
export PLEXORA_TELEMETRY=off

plexora telemetry preview prints exactly what the next upload would contain, and plexora telemetry status says which of the above is in force. docs/TELEMETRY.md has the details.

Free and Paid

Free is everything described above: every image, table and modality, every tool's manual features, remote, HPC and notebook viewing, and export. It needs no account, no activation and no network, and it never asks.

Paid adds AI features: guided gating sessions an agent runs with you, and the evidence and analysis tools it uses. Licences, devices and AI credits are managed on the BioCognia platform, which Plexora shares with SCIMAP Pro: you sign in at account.biocognia.com, never in Plexora. In Settings > License, Connect this device shows a short code and opens the page to approve it; or, from a terminal:

plexora license status
plexora license activate                            # this computer: prints a code to approve in the browser
plexora license activate BIOC-XXXX-XXXX-XXXX-XXXX   # with your licence key from the portal, no browser needed
plexora license activate --cluster --name O2        # a whole HPC cluster, once, from a login node
plexora license install lab.bioc                    # an offline licence file
plexora license trial                               # 30 days of Paid

A licence check sends the licence certificate and a hash that identifies the device. It never sends your data, file names, machine names or anything about what you are looking at. When a licence ends, everything Free keeps working, and every gate, ROI, figure and export you made, with or without AI, stays yours and editable. AI model providers your agent uses bill you separately. docs/LICENSING.md has the details.

License

Plexora is released under the Plexora Academic License 1.0 (see LICENSE). It is not an open source license. In short:

Academic research, teaching, personal study ✅ Free
Use by a nonprofit or government research institution ✅ Free (whatever the funding source)
Redistributing Plexora unmodified, with the license attached ✅ Allowed
Patching your own copy to fix a bug or a compatibility problem ✅ Allowed
Publishing a fork, a patched build, or a renamed version ❌ Not allowed
Commercial use of any kind ❌ Requires a paid license

Plugins are a deliberate exception. Anything you build against the documented extension interfaces — the plexora.plugins entry point group and the plexora.api package — is yours. You may distribute and sell your plugin under whatever license you like, and you do not need our permission. Extending Plexora through the plugin API is the supported way to change what it does; editing its source is not.

For a commercial license, contact Ajit Johnson Nirmal ajitjohnson.n@gmail.com.

Some bundled components carry their own licenses, which are unaffected by the above — see section 8 of LICENSE.

Metadata

Release files for plexora 0.0.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plexora 0.0.28
File Size Uploaded Provenance Actions
plexora-0.0.28.tar.gz 13.5 MB Without provenance Details for plexora-0.0.28.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for plexora 0.0.28
File Interpreter ABI Platform Actions
plexora-0.0.28-py3-none-any.whl Python 3 none any Details for plexora-0.0.28-py3-none-any.whl

Total release size: 26.2 MB

Release files / plexora-0.0.28.tar.gz

Download URL plexora-0.0.28.tar.gz
Size 13.5 MB
Tags Source
SHA-256 checksum
How to use checksums
0ef3c5685f88589234cf6c338966a2a4833283caf9259e252ab848d6abb851f5
BLAKE2b-256 checksum
How to use checksums
119ed61bb59931ec4664ce5c6fbbf9d6d16127762257da678e99bdb0145d48c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.14

Release files / plexora-0.0.28-py3-none-any.whl

Download URL plexora-0.0.28-py3-none-any.whl
Size 12.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
22aa2c0d13f56e7221939225f5112205d67b65e620a4cf07df43dabbc87160a4
BLAKE2b-256 checksum
How to use checksums
df867c722e4a24e4055225f2b1b55911fb17a00520d9c1987f356def74e8742c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.14

Security for plexora 0.0.28

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page