A visualisation tool for protein embeddings from pLMs
Project description
ProtSpace
ProtSpace is a visualization tool for exploring protein embeddings or similarity matrices along their 3D protein structures. It allows users to interactively visualize high-dimensional protein language model data in 2D or 3D space, color-code proteins based on various features, and view protein structures when available.
🌐 Try Online
Web Interface: https://protspace.rostlab.org/
🚀 Quick Start with Google Colab
Note: Use Chrome or Firefox for best experience.
📦 Installation
# Basic installation (backend - dimensionality reduction only)
pip install protspace
# Full installation (backend + frontend - including visualization interface)
pip install "protspace[frontend]"
🎯 Usage
1. Query UniProt directly
# Search and analyze proteins from UniProt
protspace-query -q "insulin AND organism_id:9606 AND reviewed:true" -o output_dir --methods pca2,umap3
2. Process local data
# Process your own embeddings or similarity matrices
protspace-local -i embeddings.h5 -m features.csv -o output_dir --methods pca2,pca3
3. Launch visualization
# Auto-detects JSON files or Arrow directories
protspace output_dir
protspace output.json
Access at http://localhost:8050
✨ Features
- Interactive visualization: 2D/3D plots with multiple dimensionality reduction methods (PCA, UMAP, t-SNE, MDS, PaCMAP)
- Feature-based styling: Color-code and shape proteins by various features
- Structure integration: View 3D protein structures alongside embeddings
- Search & highlight: Find and highlight specific proteins
- Export options: High-quality SVG (2D) and interactive HTML (3D)
- Responsive interface: Works on desktop and mobile
📊 Example Outputs
2D Scatter Plot
3D Interactive Plot
🔧 Advanced Usage
Command Options
protspace-query (UniProt search):
-q, --query: UniProt search query (required)-o, --output: Output directory (required)-m, --metadata: Features to extract (comma-separated)--methods: Reduction methods (e.g.,pca2,umap3,tsne2)--non-binary: Use legacy JSON format--keep-tmp: Keep temporary files
protspace-local (Local data):
-i, --input: HDF5 embeddings or CSV similarity matrix (required)-m, --metadata: CSV metadata file or feature list (required)-o, --output: Output directory (required)--methods: Reduction methods (e.g.,pca2,umap3,tsne2)--non-binary: Use legacy JSON format
Method Parameters
Fine-tune dimensionality reduction:
- UMAP:
--n_neighbors 15 --min_dist 0.1 - t-SNE:
--perplexity 30 --learning_rate 200 - PaCMAP:
--mn_ratio 0.5 --fp_ratio 2.0 - MDS:
--n_init 4 --max_iter 300 --eps 1e-3
Custom Styling
protspace-feature-colors input.json output.json --feature_styles '{
"feature_name": {
"colors": {"value1": "#FF0000", "value2": "#00FF00"},
"shapes": {"value1": "circle", "value2": "square"}
}
}'
Available shapes: circle, circle-open, cross, diamond, diamond-open, square, square-open, x
📁 File Formats
Input
- UniProt queries: Text queries using UniProt syntax
- Embeddings: HDF5 files (.h5, .hdf5)
- Similarity matrices: CSV files with symmetric matrices
- Metadata: CSV with 'identifier' column + feature columns
- Structures: ZIP files containing PDB/CIF files
Output
- Default: Parquet files (projections_data.parquet, projections_metadata.parquet, selected_features.parquet)
- Legacy: JSON format with
--non-binaryflag - Temporary files: FASTA sequences, similarity matrices, all features (with
--keep-tmp)
📝 Citation
@article{SENONER2025168940,
title = {ProtSpace: A Tool for Visualizing Protein Space},
journal = {Journal of Molecular Biology},
pages = {168940},
year = {2025},
issn = {0022-2836},
doi = {https://doi.org/10.1016/j.jmb.2025.168940},
url = {https://www.sciencedirect.com/science/article/pii/S0022283625000063},
author = {Tobias Senoner and Tobias Olenyi and Michael Heinzinger and Anton Spannagl and George Bouras and Burkhard Rost and Ivan Koludarov}
}
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 protspace-2.1.1.tar.gz.
File metadata
- Download URL: protspace-2.1.1.tar.gz
- Upload date:
- Size: 98.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3f676590896b908f13a10f2d740fe6e140a6f6e3f1b41c1f77f4cca002f89c87
|
|
| MD5 |
f7baa10498f9d2312cbcd3903577ecac
|
|
| BLAKE2b-256 |
4b5c7a1b26a3980c3a4d64ba773a1147458138b02714261e7b30fce9ea6ee97e
|
Provenance
The following attestation bundles were made for protspace-2.1.1.tar.gz:
Publisher:
python.yml on tsenoner/protspace
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
protspace-2.1.1.tar.gz -
Subject digest:
3f676590896b908f13a10f2d740fe6e140a6f6e3f1b41c1f77f4cca002f89c87 - Sigstore transparency entry: 265659170
- Sigstore integration time:
-
Permalink:
tsenoner/protspace@e45f169c5d55e89043236cee446e8ab71ad21a0c -
Branch / Tag:
refs/heads/main - Owner: https://github.com/tsenoner
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python.yml@e45f169c5d55e89043236cee446e8ab71ad21a0c -
Trigger Event:
repository_dispatch
-
Statement type:
File details
Details for the file protspace-2.1.1-py3-none-any.whl.
File metadata
- Download URL: protspace-2.1.1-py3-none-any.whl
- Upload date:
- Size: 639.7 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 |
a999c74518af0ca033ed98ae3241c1d03e433e3530e3edfba1cccbac8ac65cb7
|
|
| MD5 |
1b65ae3fb49fbfd1667c1af0c5550348
|
|
| BLAKE2b-256 |
42073df6e92444acc767cb8b674369aac59dac3b9a8a2beb43cab1ed1b531e46
|
Provenance
The following attestation bundles were made for protspace-2.1.1-py3-none-any.whl:
Publisher:
python.yml on tsenoner/protspace
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
protspace-2.1.1-py3-none-any.whl -
Subject digest:
a999c74518af0ca033ed98ae3241c1d03e433e3530e3edfba1cccbac8ac65cb7 - Sigstore transparency entry: 265659174
- Sigstore integration time:
-
Permalink:
tsenoner/protspace@e45f169c5d55e89043236cee446e8ab71ad21a0c -
Branch / Tag:
refs/heads/main - Owner: https://github.com/tsenoner
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python.yml@e45f169c5d55e89043236cee446e8ab71ad21a0c -
Trigger Event:
repository_dispatch
-
Statement type: