Skip to main content

Spatial Single-Cell Analysis Toolkit

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scimap-2.3.4.tar.gz (11.5 MB view details)

Uploaded Source

Built Distribution

scimap-2.3.4-py3-none-any.whl (11.5 MB view details)

Uploaded Python 3

File details

Details for the file scimap-2.3.4.tar.gz.

File metadata

  • Download URL: scimap-2.3.4.tar.gz
  • Upload date:
  • Size: 11.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.9 Darwin/24.4.0

File hashes

Hashes for scimap-2.3.4.tar.gz
Algorithm Hash digest
SHA256 756470fe9924abb682dbe8c6eed42e70761e3222bdbde65da4875210bb5a4301
MD5 0f47a5d43be9c15406221ec5fd270b7a
BLAKE2b-256 bcf3f2cd91b565efcca22125d3284b9b38a50902102549a6f4f0c1a8b5ab5809

See more details on using hashes here.

File details

Details for the file scimap-2.3.4-py3-none-any.whl.

File metadata

  • Download URL: scimap-2.3.4-py3-none-any.whl
  • Upload date:
  • Size: 11.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.9 Darwin/24.4.0

File hashes

Hashes for scimap-2.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 092e239130def537bb1688925496459c13f71319bf3b8c59dade8e6cd170ea1c
MD5 03e84187cda936a29e51e117b30a0538
BLAKE2b-256 06744534eb9e476be01b8503648f07c920fc152ed1512e7296cc8fe13bd2d2c3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page