Skip to main content

Python Toolkit for Transcription Factor Activity Inference and Clustering of scRNA-seq Data

Project description

scRegulate

Single-Cell Regulatory-Embedded Variational Inference of Transcription Factor Activity from Gene Expression

GitHub issues Conda PyPI - Project Documentation Status

Introduction

scRegulate is a powerful tool designed for the inference of transcription factor activity from single cell/nucleus RNA data using advanced generative modeling techniques. It leverages a unified learning framework to optimize the modeling of cellular regulatory networks, providing researchers with accurate insights into transcriptional regulation. With its efficient clustering capabilities, scRegulate facilitates the analysis of complex biological data, making it an essential resource for studies in genomics and molecular biology.



For further information and example tutorials, please check our documentation.

If you have any questions or concerns feel free to open an issue.

Requirements

scRegulate is implemented in the PyTorch framework. Running scRegulate on CUDA is highly recommended if available.

Before installing and running scRegulate, ensure you have the following libraries installed:

  • PyTorch (version 2.0 or higher)
  • NumPy (version 1.23 or higher)
  • Scanpy (version 1.9 or higher)
  • Anndata (version 0.8 or higher)

You can install these dependencies using pip:

pip install torch numpy scanpy anndata

Installation

You can install scRegulate via pip for a lightweight installation:

pip install scRegulate

Alternatively, if you want the latest, unreleased version, you can install it directly from the source on GitHub:

pip install git+https://github.com/YDaiLab/scRegulate.git

For users who prefer Conda or Mamba for environment management, you can install scRegulate along with extra dependencies using:

mamba create -n=scRegulate conda-forge::scRegulate

License

The code in scRegulate is licensed under the MIT License, which permits academic and commercial use, modification, and distribution.

Please note that any third-party dependencies bundled with scRegulate may have their own respective licenses.

Citation

scRegulate manuscript is currently under peer review.

If you use scRegulate in your research, please cite:

Mehrdad Zandigohar, Jalees Rehman and Yang Dai (2025). scRegulate: Single-Cell Regulatory-Embedded Variational Inference of Transcription Factor Activity from Gene Expression, Bioinformatics Journal (under review). [DOI link here]

📄 Read the preprint on bioRxiv: 10.1101/2025.04.17.649372

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

scregulate-0.1.9.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

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

scregulate-0.1.9-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file scregulate-0.1.9.tar.gz.

File metadata

  • Download URL: scregulate-0.1.9.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scregulate-0.1.9.tar.gz
Algorithm Hash digest
SHA256 856d66c09f2ea631f0a18c775b83af10625a3d6a3e493292273dd521be9c9036
MD5 3c611289596a6514200e979829167ada
BLAKE2b-256 75f2351ae03d8e9c8c2785a099a7eafcf6e07be0a918d2e66e256b00aa586345

See more details on using hashes here.

Provenance

The following attestation bundles were made for scregulate-0.1.9.tar.gz:

Publisher: python-publish.yml on YDaiLab/scRegulate

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

File details

Details for the file scregulate-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: scregulate-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scregulate-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c41dd45f77fe0af6e013531c183ab36893d2fba4adba6e7cd396e28fbf1797da
MD5 0a10849363c75716015cd35cff298446
BLAKE2b-256 03e4c24e484f9ac616eb871e9f0b730e893625f8efab4f3465d963c5f2d32df9

See more details on using hashes here.

Provenance

The following attestation bundles were made for scregulate-0.1.9-py3-none-any.whl:

Publisher: python-publish.yml on YDaiLab/scRegulate

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