scFocus
Overview
scFocus is a reinforcement-learning-based method for analyzing lineage branching in low-dimensional single-cell embeddings. It combines branch probabilities with unsupervised structure in the latent space to help characterize continuous cell-state transitions and related visualization workflows.
Graphical Abstract
Installation
Requirements
- Python >= 3.9
- Required packages:
scanpy>=1.10.4,torch>=1.13.1,joblib>=1.2.0,tqdm>=4.64.1,streamlit>=1.24.0
Install from PyPI
pip install scfocus-sc
From version 0.0.6 the package is published on PyPI as scfocus-sc; the import name is still scfocus. The earlier scfocus project on PyPI stays at 0.0.5 and is no longer updated.
Install from source
git clone https://github.com/PeterPonyu/scfocus.git
cd scfocus
pip install -e .
Quick Start
Basic example to get started with scFocus:
import scanpy as sc
import scfocus
# Load your single-cell data
adata = sc.read_h5ad('your_data.h5ad')
# Preprocess: normalize, log-transform, and compute PCA
sc.pp.normalize_total(adata, target_sum=1e4)
sc.pp.log1p(adata)
sc.pp.highly_variable_genes(adata, n_top_genes=2000)
adata = adata[:, adata.var.highly_variable]
sc.pp.pca(adata)
# Compute UMAP embedding
sc.pp.neighbors(adata, n_neighbors=15)
sc.tl.umap(adata)
# Run scFocus analysis
embedding = adata.obsm['X_umap']
focus = scfocus.focus(embedding, n=6, pct_samples=0.01)
focus.meta_focusing(n=3)
focus.merge_fp2()
# Add focus probabilities to your AnnData object
adata.obsm['focus_probs'] = focus.mfp[0]
for i in range(focus.mfp[0].shape[1]):
adata.obs[f'Fate_{i}'] = focus.mfp[0][:, i]
# Visualize results
sc.pl.umap(adata, color=[f'Fate_{i}' for i in range(focus.mfp[0].shape[1])])
Key Parameters
The focus class accepts the following key parameters:
- f (array-like): Latent space of the original data (e.g., UMAP or t-SNE coordinates)
- n (int, default=8): Number of parallel agents/branches to identify
- pct_samples (float, default=0.125): Percentage of samples used in each training step
- max_steps (int, default=5): Maximum steps per training episode
- num_episodes (int, default=1000): Number of training episodes
- hidden_dim (int, default=128): Hidden layer dimension for neural networks
- res (float, default=0.05): Resolution for merging similar focus patterns
For a complete list of parameters and their descriptions, see the API documentation.
Documentation
Tutorials and API documentation are available at https://scfocus.readthedocs.io/en/latest/, including:
- Notebooks for different datasets
- Step-by-step tutorials
- API reference
Web Interface
scFocus provides an interactive web interface for data analysis.
Online Access
Access the hosted version at scfocus.streamlit.app.
Local Interface
Launch the local web interface:
scfocus ui
Using the Web Interface
- Upload Data: Support for
.h5adfiles or 10x Genomics format (matrix.mtx, features.tsv, barcodes.tsv) - Configure Parameters:
- Number of highly variable genes (200-5000, default: 2000)
- Number of neighbors for UMAP (2-50, default: 15)
- Minimum distance for UMAP (0.0-2.0, default: 0.5)
- Number of branches (2-10, default: 6)
- Process: Click "Process" to run the analysis pipeline
- Visualize: View UMAP plots colored by cell fate probabilities
- Download: Export processed data as
.h5adfile
Example datasets are available in the data/ folder of the repository.
Command Line Interface
Available Commands
# Launch web interface
scfocus ui
# Additional CLI commands may be added in future releases
Workflow Overview
The typical scFocus workflow consists of:
- Preprocessing: Normalize and log-transform the data, select highly variable genes
- Dimensionality Reduction: Compute PCA and UMAP/t-SNE embeddings
- scFocus Analysis: Apply reinforcement learning to identify lineage branches
- Merge Patterns: Consolidate similar focus patterns
- Visualization: Display cell fate probabilities and branch assignments
Troubleshooting
Common Issues
Issue: ModuleNotFoundError: No module named 'torch'
- Solution: Install PyTorch:
pip install torch>=1.13.1
Issue: CUDA out of memory error
- Solution: The algorithm automatically uses CPU if GPU is unavailable. For large datasets, consider reducing
n(number of agents) orpct_samples.
Issue: Streamlit command not found
- Solution: Install streamlit:
pip install streamlit>=1.24.0
Issue: Analysis is slow
- Solution:
- Reduce
num_episodes(default 1000) for faster results - Decrease
n(number of agents) to reduce computational load - Use GPU if available
- Reduce
Getting Help
- Check the documentation
- Open an issue on GitHub
- Review example notebooks in the documentation
Development
Setting Up Development Environment
# Clone the repository
git clone https://github.com/PeterPonyu/scfocus.git
cd scfocus
# Install in development mode
pip install -e .
# Install additional development dependencies
pip install -r requirements.txt
Building Documentation
The documentation is built using Sphinx:
# Install Sphinx and dependencies
pip install sphinx sphinx-rtd-theme
# Build the documentation
cd source
make html
The documentation will be built in build/html/.
License
Citation
Chen, C., Fu, Z., Yang, J., Chen, H., Huang, J., Qin, S., Wang, C., & Hu, X. (2025). scFocus: Detecting Branching Probabilities in Single-cell Data with SAC. Computational and Structural Biotechnology Journal, 27, 2243–2263. https://doi.org/10.1016/j.csbj.2025.04.036
Metadata
Release files for scfocus-sc 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scfocus_sc-0.0.6.tar.gz | 915.2 kB | With provenance | Details for scfocus_sc-0.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scfocus_sc-0.0.6-py3-none-any.whl | Python 3 | none | any | Details for scfocus_sc-0.0.6-py3-none-any.whl |
Total release size: 1.8 MB
Release files / scfocus_sc-0.0.6.tar.gz
| Download URL | scfocus_sc-0.0.6.tar.gz |
|---|---|
| Size | 915.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73f476f0dc27db02eebddc2226f7adff6f800d76c7ad77891311620fbfedc4a0
|
|
BLAKE2b-256 checksum How to use checksums |
12d6c86919a6088f4f86e0a8e1dbcb898a44a9b7612810367c4c74384a6f0944
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 16, 2026.
Transparency logRelease files / scfocus_sc-0.0.6-py3-none-any.whl
| Download URL | scfocus_sc-0.0.6-py3-none-any.whl |
|---|---|
| Size | 913.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e5701befb0d6876e1d213b60a8f1597ccd327ed2f7dbb0db2c665b56d12e898
|
|
BLAKE2b-256 checksum How to use checksums |
50639a30e1a2aaca509972e57c7cdd85d65426b18e0fc8c64ef31100399be0da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 16, 2026.
Transparency logSecurity for scfocus-sc 0.0.6
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for scfocus_sc-0.0.6.tar.gz
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 Nov 16, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.