Skip to main content

SCIMAP: A Python Toolkit for Integrated Spatial Analysis of Multiplexed Imaging Data


build-unix-mac-win docs Downloads PyPI Version PyPI License DOI



Scimap is a scalable toolkit for analyzing spatial molecular data. The underlying framework is generalizable to spatial datasets mapped to XY coordinates. The package uses the anndata framework making it easy to integrate with other popular single-cell analysis toolkits. It includes preprocessing, phenotyping, visualization, clustering, spatial analysis and differential spatial testing. The Python-based implementation efficiently deals with large datasets of millions of cells.

Citing scimap

Nirmal et al., (2024). SCIMAP: A Python Toolkit for Integrated Spatial Analysis of Multiplexed Imaging Data. Journal of Open Source Software, 9(97), 6604, https://doi.org/10.21105/joss.06604

Installation

We strongly recommend installing scimap in a fresh virtual environment.

# If you have conda installed
conda create --name scimap python=3.10
conda activate scimap

Install scimap directly into an activated virtual environment:

Firstly, we suggest installing scimap and napari together to enable visualization out of the box. Keep in mind, napari needs a GUI toolkit, such as PyQt. If you run into any issues because of your computer's operating system, install scimap and napari separately by following the guidance in napari's documentation.

Here's how you can install both using pip:

pip install "scimap[napari]"

If you encounter a problem with PyQt6 during the installation, you can install scimap alone first. Later on, if you find you need napari, you can go ahead and install it by itself.

To install just scimap:

pip install scimap

After installation, the package can be imported as:

$ python
>>> import scimap as sm

Get Started

Detailed documentation of scimap functions and tutorials are available here.

Scimap development was led by Ajit Johnson Nirmal, Harvard Medical School.
Check out other tools from the Nirmal Lab.

Contibute

Interested in contributing to the package? Check out our guidelines at https://scimap.xyz/contribute/ for detailed instructions.

Funding

This work was supported by the following NIH grant K99-CA256497

Metadata

Release files for scimap 2.4.1

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

Source distribution (sdist)

Source distribution for scimap 2.4.1
File Size Uploaded Provenance Actions
scimap-2.4.1.tar.gz 11.5 MB Without provenance Details for scimap-2.4.1.tar.gz

Built distribution (wheel)

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

Total release size: 23.0 MB

Release files / scimap-2.4.1.tar.gz

Download URL scimap-2.4.1.tar.gz
Size 11.5 MB
Tags Source
SHA-256 checksum
How to use checksums
b24895d018b51804fe2fb74779fce7f0efd9d5ea2cb29fde0b723c7870bc8fac
BLAKE2b-256 checksum
How to use checksums
770f63d6c3330bed2b133c646ece4ea738bd479b4035525e9a73ad702008c03e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.10.9 Darwin/25.6.0

Release files / scimap-2.4.1-py3-none-any.whl

Download URL scimap-2.4.1-py3-none-any.whl
Size 11.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3dfc6a7f61c64c29b8b73a4aad0798392b3b63b561a0bbda05c16e35a0679699
BLAKE2b-256 checksum
How to use checksums
e51de1fcc8123214fbe266cfcfef6aefa5c2ddefa427232f5bce0160caeca58d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.10.9 Darwin/25.6.0

Security for scimap 2.4.1

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

This release

2.4.1 This release

2 release files No provenance

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