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 Downloads 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.1.tar.gz (19.3 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.1-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scregulate-0.1.1.tar.gz
  • Upload date:
  • Size: 19.3 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.1.tar.gz
Algorithm Hash digest
SHA256 2e1e4bf2cd8b51f9c997de5c7699bd2ff335256007fa1a46d7131b2b5519022a
MD5 ba75b80e82fa6e0818e765206d0131de
BLAKE2b-256 a34290d27202c8af5b4929093ca01998f1aff759f39b18e85bcd2ee279251687

See more details on using hashes here.

Provenance

The following attestation bundles were made for scregulate-0.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: scregulate-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4343ceb0c3fabe01721f4630751474403975e2c5add3f5f99aa52cc898c038a0
MD5 6091ab6226178931c8204837b8d86529
BLAKE2b-256 2aebeb1857b92bd53bb75433509cc48b3ac13caca4f3775a525335338d5384ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for scregulate-0.1.1-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