Skip to content

pnucolab/stLENS

Repository files navigation

stLENS

stLENS is a python-based scalable tool for determining the optimal number of principal components from spatial transcriptomics data. It is designed to handle large-scale spatial omics datasets efficiently.

Features

  • Scalable Analysis: Efficiently handles large spatial transcriptomics datasets
  • Optimal PC Selection: Determines the optimal number of principal components using advanced statistical methods
  • scverse Compatible: Seamlessly integrates with scanpy and other scverse tools
  • GPU Acceleration: Leverages CUDA for high-performance computing
  • Spatial-aware: Specifically designed for spatial transcriptomics data analysis

Installation

Prerequisites

  • Python 3.9, 3.10, or 3.11
  • CUDA-compatible GPU (for GPU acceleration)

Install CuPy (Optional)

conda install cupy

Install from PyPI

pip install stLENS

Development Installation

git clone https://github.com/pnucolab/stLENS.git
cd stLENS
pip install -e .

Quick Start

from stLENS import stLENS
import scanpy as sc
import anndata as ad

# Load your spatial transcriptomics data
adata = sc.read_h5ad("your_spatial_data.h5ad")

# Initialize stLENS
stlens = stLENS()

# Determine optimal number of PCs
stlens.find_optimal_pc(adata)

Documentation

For detailed documentation, tutorials, and API reference, visit: https://stlens.readthedocs.io/

Tutorials

We provide comprehensive tutorials and reproducible examples:

Getting Started

  • Basic Tutorial - Introduction to stLENS basics and core functionality

Paper Figure Reproduction

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •