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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file scregulate-0.1.4.tar.gz.
File metadata
- Download URL: scregulate-0.1.4.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6440a32d9d6ffb7900f416473f4a200adc6ea6d8e31bbebdfb871a68243e8529
|
|
| MD5 |
62afbd8d60957ce12fc600418bbbc127
|
|
| BLAKE2b-256 |
36191b27ae2e72af3f2ccc524116db9ffeb51fb72fa4d92263cc8b4ea65f0aca
|
Provenance
The following attestation bundles were made for scregulate-0.1.4.tar.gz:
Publisher:
python-publish.yml on YDaiLab/scRegulate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
scregulate-0.1.4.tar.gz -
Subject digest:
6440a32d9d6ffb7900f416473f4a200adc6ea6d8e31bbebdfb871a68243e8529 - Sigstore transparency entry: 207058713
- Sigstore integration time:
-
Permalink:
YDaiLab/scRegulate@b23a3807cd04c1ad1e41d923f4173e06b1c6eaf6 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/YDaiLab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@b23a3807cd04c1ad1e41d923f4173e06b1c6eaf6 -
Trigger Event:
release
-
Statement type:
File details
Details for the file scregulate-0.1.4-py3-none-any.whl.
File metadata
- Download URL: scregulate-0.1.4-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3f40c1b403faf4100b1440dd8b070d8504cee5c9e0d20be956f2fe0a143ea27
|
|
| MD5 |
ba872366570639f0782ffa847adfd33f
|
|
| BLAKE2b-256 |
5e147c1e534d537900608a33fe9fc915199638cd9ccb5acd7ba8147624970441
|
Provenance
The following attestation bundles were made for scregulate-0.1.4-py3-none-any.whl:
Publisher:
python-publish.yml on YDaiLab/scRegulate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
scregulate-0.1.4-py3-none-any.whl -
Subject digest:
e3f40c1b403faf4100b1440dd8b070d8504cee5c9e0d20be956f2fe0a143ea27 - Sigstore transparency entry: 207058721
- Sigstore integration time:
-
Permalink:
YDaiLab/scRegulate@b23a3807cd04c1ad1e41d923f4173e06b1c6eaf6 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/YDaiLab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@b23a3807cd04c1ad1e41d923f4173e06b1c6eaf6 -
Trigger Event:
release
-
Statement type: