scRegulate
Single-Cell Regulatory-Embedded Variational Inference of Transcription Factor Activity from Gene Expression
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)
Install with the exact command from the PyTorch “Get Started” page for your OS, Python version and (optionally) CUDA toolkit. - 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
Option 1:
You can install scRegulate via pip for a lightweight installation:
pip install scregulate
Option 2:
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
Option 3:
For users who prefer Conda or Mamba for environment management, you can install scRegulate along with extra dependencies:
Conda:
conda install -c zandigohar scregulate
Mamba:
mamba create -n scRegulate -c zandigohar scregulate
FAQ
Q1: Do I need a GPU to run scRegulate?
No, a GPU is not required. However, using a CUDA-enabled GPU is strongly recommended for faster training and inference, especially with large datasets.
Q2: How do I know if I can use a GPU with scRegulate?
There are two quick checks:
-
System check
In your terminal, runnvidia-smi. If you see your GPU listed (model, memory, driver version), your machine has an NVIDIA GPU with the driver installed. -
Python check
In a Python shell, run:import torch print(torch.cuda.is_available()) # True means PyTorch can see your GPU print(torch.cuda.device_count()) # How many GPUs are usable
Q3: Can I use scRegulate with Seurat or R-based tools?
scRegulate is written in Python and works directly with AnnData objects (e.g., from Scanpy). You can convert Seurat objects to AnnData using tools like SeuratDisk.
Q4: How can I visualize inferred TF activities?
TF activities inferred by scRegulate are stored in the obsm slot of the AnnData object. You can use scanpy.pl.embedding, scanpy.pl.heatmap, or export the matrix for custom plots.
Q5: What kind of prior networks does scRegulate accept?
scRegulate supports user-provided gene regulatory networks (GRNs) in CSV or matrix format. These can be curated from public databases or inferred from ATAC-seq or motif analysis.
Q6: Can I use scRegulate for multi-omics integration?
Not directly. While scRegulate focuses on TF activity from RNA, you can incorporate priors derived from other omics (e.g., ATAC) to guide the model.
Q7: What file formats are supported?
scRegulate works with .h5ad files (AnnData format). Input files should contain gene expression matrices with proper normalization.
Q8: How do I cite scRegulate?
See the Citation section below for the latest reference and preprint link.
Q9: How can I reproduce the paper’s results?
See our Reproducibility Guide for step-by-step instructions. Then run scregulate.
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).
📄 Read the preprint on bioRxiv: 10.1101/2025.04.17.649372
Development & Contact
scRegulate was developed and is actively maintained by Mehrdad Zandigohar as part of his PhD research at the University of Illinois Chicago (UIC), in the lab of Dr. Yang Dai.
📬 For private questions, please email: mzandi2@uic.edu
🤝 For collaboration inquiries, please contact PI: Dr. Yang Dai (yangdai@uic.edu)
Contributions, feature suggestions, and feedback are always welcome!
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.
Metadata
Release files for scRegulate 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scregulate-1.0.1.tar.gz | 24.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scregulate-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.9 kB
Release files / scregulate-1.0.1.tar.gz
| Download URL | scregulate-1.0.1.tar.gz |
|---|---|
| Size | 24.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
94d77b3576d324b10b236bca3904848f7129f08e24ccdbb1ecb7f83d100e56de
|
|
BLAKE2b-256 checksum How to use checksums |
0bd1bd00b97c7504e60e89cf4464a86e6b0321f1c7bc1137aa3f11f60a2f8170
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2025.
Transparency logRelease files / scregulate-1.0.1-py3-none-any.whl
| Download URL | scregulate-1.0.1-py3-none-any.whl |
|---|---|
| Size | 29.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e608e08addc894d8c7b3236ead722cbe0c5ccf7e2f6d1de64b6828dc784391e
|
|
BLAKE2b-256 checksum How to use checksums |
c81990e77d0f8c24d5cd37b7f780b131a270bb7bd08993ad998f250f8260c0fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2025.
Transparency log