Skip to main content

A package for Subcellular Location Optimal Transport (SLOT) algorithm.

Project description

Subcellular Location Optimal Transport (SLOT)

PyPI version Python License: MIT

SLOT is an optimal-transport–based machine learning framework for quantifying and modeling the spatial–temporal localization of intracellular molecules.

Introduction

By integrating subcellular-resolution spatial transcriptomics (mRNA) and proteomics (protein) datasets, SLOT systematically aligns and compares molecular distributions across cellular compartments and temporal stages. The framework infers relocation trajectories and quantifies dynamic shifts in subcellular localization patterns. As a comprehensive computational toolbox, SLOT enables systematic modeling of subcellular molecular spatial polarity, supporting pattern detection, spatial-location clustering investigations and spatiotemporal dynamic analysis.

SLOT Framework Overview

Features

  • Spatial localization polarity quantification
  • Location patterns matching
  • Subcellular location clustering
  • Spatial-temporal co-localization detection

Installation

Prerequisites

  • Python 3.10 or higher

Install from PyPI (Recommended)

pip install slot-toolkit

Install from Source

  1. Clone the repository:

    git clone https://github.com/Lifeomics/SLOT.git
    cd SLOT
    
  2. Create a conda environment and activate it:

    conda create --name SLOT_env python=3.10
    conda activate SLOT_env
    
  3. Install SLOT and its dependencies:

    pip install .
    

    For development / editable install (changes to source take effect immediately):

    pip install -e .
    

Installation typically takes 1–2 minutes.

Quick Start

import SLOT

# Load your spatial omics data
adata = SLOT.data.load_data("path/to/data.h5ad")

# Compute SLOT polarity scores
scores = SLOT.model.compute_slot_score(adata)

# Cluster subcellular localization patterns
SLOT.cluster.run_clustering(adata)

# Visualize results
SLOT.plot.bindingplot(adata)

Tutorials

Tutorial Description
Tutorial 1: SLOT Score Identify spatial polarity proteins at subcellular resolution
Tutorial 2: SLOT Cluster Cluster subcellular localization patterns
Tutorial 3: Pattern Matching Match and compare spatial distribution patterns

The processed data used in tutorials are available at XenoSTAR.

Citation

If you use SLOT in your research, please cite our paper (coming soon).

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

slot_toolkit-1.0.1.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

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

slot_toolkit-1.0.1-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file slot_toolkit-1.0.1.tar.gz.

File metadata

  • Download URL: slot_toolkit-1.0.1.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slot_toolkit-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c6fc31389093a40a976cbbb68f7452508a5ac7a3c45fe18e7c861c2dc382e963
MD5 be0100f0fbb24d228c5c577e6f08dbd7
BLAKE2b-256 30ab06f9202a6940f5d23be4ed85094f004f5dae27c4977c75d50e2584b37651

See more details on using hashes here.

Provenance

The following attestation bundles were made for slot_toolkit-1.0.1.tar.gz:

Publisher: release.yml on Lifeomics/SLOT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slot_toolkit-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: slot_toolkit-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slot_toolkit-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 874537ba416bf5d2751fd086b743633ae1c6c1a13852852ae730cb9c6c2c3af9
MD5 ae98775575b639cd10f55e1640bb1076
BLAKE2b-256 6a60d57795f53750e23eabdf0d873e23c18a62c485d0a851c9c513e864c98d61

See more details on using hashes here.

Provenance

The following attestation bundles were made for slot_toolkit-1.0.1-py3-none-any.whl:

Publisher: release.yml on Lifeomics/SLOT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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