Skip to content

Latest commit

 

History

138 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proteomes2Structs

Shell GitHub tag (latest) DOI License: CC-BY-NC-4.0

Proteomes2Structs is a data acquisition tool for reproducible, proteome‑scale downloads of AlphaFold DB structures and metadata. It is designed for downstream pipelines that require consistent directory layouts, structured metadata, and reliable parallel downloads across thousands of proteins. At present, only UniProt proteomes are supported.

Quick start

Download structures for E. coli:

proteomes2structs --cif "UP000000625" data

Installation

Manual installation (until Bioconda package is available)

Clone the repository:

git clone https://github.com/CielResearch/Proteomes2Structs.git
cd Proteomes2Structs

Make the wrapper executable:

chmod +x bin/proteomes2structs

(Optional) Add the tool to your PATH:

export PATH="$PWD/bin:$PATH"

You can now run:

proteomes2structs --help

Bioconda installation (coming soon)

Once the Bioconda recipe is accepted, you will be able to install Proteomes2Structs with:

conda install -c bioconda proteomes2structs

Usage

Usage: proteomes2structs [options] "PROTEOME_LIST" OUTPUT_DIR

Example: proteomes2structs --cif "UP000000625 UP000007256" ../data

Required positional arguments:

Positional Argument Example Notes
"PROTEOME_LIST" "UP000000625 UP000007256" Quoted space-separated UniProt proteome accession/s
OUTPUT_DIR ../data Directory where downloaded files will be stored

Flags/Options

Category Flag/Option Default Notes
File format --cif Download .mmCIF/.cif files
File format --pdb Download .pdb files
Parallelism --threads 12 Number of download threads
Mode --mode=download Run proteomes2structs in download mode (default mode)
Other --keep-fasta Do not automatically delete FASTA files
Other --sui 5 Status update interval in minutes

Notes:

  • At least one file format flag must be enabled (--cif or --pdb).

Output Directory Structure

OUTDIR/
    proteome1/
        json/ # AFDB metadata snapshots per protein
        structures/ # .cif and/or .pdb files per protein
        logs/
            failures_fasta.txt
            failures_metadata.txt
            failures_structures.txt
        metadata.json # summary of timestamps, success/failure counts, taxa ID, mode
    proteome2/
        ...
    proteomeK/

Supported Proteomes

Proteomes2Structs downloads structures from AlphaFold DB for any UniProt proteome with AFDB coverage. Note that AFDB does not host most viral proteomes (except SARS‑CoV‑2), so viral proteomes will produce empty metadata and no structure files.

Performance & Reliability

Proteomes2Structs is designed for reproducible, large‑scale structural downloads. When tested on ~20,000 proteins across six proteomes (CHANGELOG.md v0.3.0a1), the pipeline achieved:

  • ~17 minutes total runtime on a home laptop (WSL2, 16 threads)
  • 0% structure download failures (excluding viral proteomes, which AFDB does not host)
  • ~0.4% metadata download failure rate, all due to missing AFDB metadata rather than pipeline errors
  • Clean handling of unsupported proteomes, such as bacteriophage λ

These numbers reflect AFDB’s upstream coverage rather than issues with Proteomes2Structs. Proteomes2Structs has not been tested on HPC environments, but runtimes are likely faster.

Contributing / Issues

Please open an issue on GitHub for bug reports or feature requests.

References

Bertoni, D., Tsenkov, M., Magana, P., Nair, S., Pidruchna, I., Querino Lima Afonso, M., Midlik, A., Paramval, U., Lawal, D., Tanweer, A., Last, M., Patel, R., Laydon, A., Lasecki, D., Dietrich, N., Tomlinson, H., Žídek, A., Green, T., Kovalevskiy, O., … Velankar, S. (2026). AlphaFold Protein Structure Database 2025: A redesigned interface and updated structural coverage. Nucleic Acids Research, 54(D1), D358–D362. https://doi.org/10.1093/nar/gkaf1226

The UniProt Consortium. (2025). UniProt: The Universal Protein Knowledgebase in 2025. Nucleic Acids Research, 53(D1), D609–D617. https://doi.org/10.1093/nar/gkae1010

Citation

APA 7

Baumann, C. I.-L. (2026). Proteomes2Structs [Shell]. Zenodo. https://doi.org/10.5281/zenodo.21850698

BibTeX

@software{baumann_proteomes2structs_2026, author = {Baumann, Ciel Ivy-Lee}, title = {Proteomes2Structs}, doi = {10.5281/zenodo.21850698}, url = {https://github.com/CielResearch/Proteomes2Structs}, year = {2026} }

License

This tool is licensed under Creative Commons Attribution–NonCommercial 4.0 International (CC BY‑NC 4.0). Commercial use and patenting are prohibited. Academic use is permitted with citation.