Skip to main content

sclab

Project description

SCLab

SCLab is an interactive single-cell analysis toolkit that provides a seamless interface for analyzing and visualizing single-cell RNA sequencing data. Built on top of popular tools like scanpy and AnnData, SCLab offers an event-driven architecture for real-time updates and interactive visualizations.

Features

  • Interactive Data Analysis: Built-in dashboard with real-time updates
  • Quality Control: Comprehensive QC metrics and filtering capabilities
  • Preprocessing: Normalization, log transformation, and scaling with progress tracking
  • Dimensionality Reduction: PCA with batch effect correction support
  • Visualization: Interactive plots and tables using plotly and itables
  • Event System: Robust event-driven architecture for real-time updates

Installation

pip install sclab

Quick Start

Open a Jupyter Notebook and run the following:

from IPython.display import display
from sclab import SCLabDashboard
import scanpy as sc

# Load your data
adata = sc.read_10x_h5("your_data.h5")

# Create dashboard
dashboard = SCLabDashboard(adata, name="My Analysis")

# Display dashboard
display(dashboard)

# The dashboard provides easy access to components:
# dashboard.ds  # Dataset (wrapper for AnnData)
# dashboard.pl  # Plotter
# dashboard.pr  # Processor

# the active AnnData object is found within the dataset object:
# dashboard.ds.adata

# by default, the dashboard will update the loaded AnnData object in-place

Components

SCLabDashboard

The main interface that integrates all components with a tabbed layout:

  • Main graph for visualizations
  • Results panel
  • Observations table
  • Genes table
  • Event logs

Dataset

Handles data management with:

  • AnnData integration
  • Interactive tables
  • Row selection and filtering
  • Metadata handling

Processor

Handles data processing steps. It is configurable with custom steps implementing the ProcessorStepBase interface. This package provides multiple examples of steps:

  • QC
  • Preprocessing
  • PCA
  • Nearest Neighbors
  • UMAP
  • Clustering

Plotter

Provides interactive visualizations with:

  • Real-time updates
  • Customizable plots
  • Batch effect visualization
  • Export capabilities

Requirements

  • Python ≥ 3.12
  • anndata ≥ 0.11.3
  • scanpy ≥ 1.10.4
  • Other dependencies listed in pyproject.toml

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Citation

If you use SCLab in your research, please cite:

@software{sclab2025,
  author = {Arriojas, Argenis},
  title = {SCLab: Interactive Single-Cell Analysis Toolkit},
  year = {2025},
  publisher = {GitHub},
  url = {https://github.com/umbibio/sclab}
}

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

sclab-0.4.1.tar.gz (137.8 kB view details)

Uploaded Source

Built Distribution

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

sclab-0.4.1-py3-none-any.whl (178.1 kB view details)

Uploaded Python 3

File details

Details for the file sclab-0.4.1.tar.gz.

File metadata

  • Download URL: sclab-0.4.1.tar.gz
  • Upload date:
  • Size: 137.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sclab-0.4.1.tar.gz
Algorithm Hash digest
SHA256 3638cb8b180d2f2f5b82bee499742d9f637999d59a60bfde01189b11c7a73836
MD5 6ff7dc4d3eb95f57f7198e9ed7b9df07
BLAKE2b-256 7421c34e8e9e1e5cf1409e8585e759c4910bbfc83881c84aa1b22b27b18eb57c

See more details on using hashes here.

Provenance

The following attestation bundles were made for sclab-0.4.1.tar.gz:

Publisher: publish.yml on umbibio/sclab

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

File details

Details for the file sclab-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: sclab-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 178.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sclab-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8412e90eb2b4603e6add7cb55155449c8cd0d6953d45845a3d26dbe3ce81a15d
MD5 00a93860e2de1ce873364b876ec199a6
BLAKE2b-256 7ec83a1e13f4b3654b33ba37b9ab81a2367e2539119d9aac542b30b86239d5cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for sclab-0.4.1-py3-none-any.whl:

Publisher: publish.yml on umbibio/sclab

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