Skip to content

JBEI/foldy-internal

Repository files navigation

Foldy

Run Boltz, DiffDock, ESM, and FolDE locally through a simple web interface.

Protein design tools like Boltz, DiffDock, and ESM are powerful but difficult to install and run. Foldy wraps them in a Docker-based interface so you can focus on your science instead of debugging environments.

What you can do:

  • Predict protein structures and binding affinities with Boltz
  • Dock small molecules with DiffDock
  • Get protein language model predictions from ESM
  • Run protein engineering campaigns via FolDE

Click here for quick setup →

Deployment Options

Foldy is a composable set of services which can be deployed lots of ways. We currently document four types of deployment: Local, Development, and Helm. The Local deployment runs Foldy with a single command using pre-built Docker images - no git clone required. The Development deployment is not fully featured - it cannot run jobs - but supports the frontend features and can easily be run on a laptop for development purposes. Foldy-in-a-box is a quick deployment option for creating a full featured Foldy instance on a Google Cloud machine. Finally, the Helm deployment is the horizontally scalable, cloud deployment built on Kubernetes. The Helm deployment is involved, but it is secure and can be scaled to hundreds of users and tens of thousands of folds.

You can find more information about employing the different deployment options in their respective deployment directories.

Deployment Type Description Ease of setup Setup
Local Full featured, single command Very easy Instructions
Development Run locally when making code changes Medium Instructions
Helm Scalable to hundreds of users Hard Instructions

FolDE Low-N Protein Optimization Workflow

The FolDE workflow, and the simulation code used in the FolDE paper, are in backend/folde. There is more information about running protein optimization simulations in backend/folde/README.md.

Interface

See docs/interface.md.

Architecture

See docs/architecture.md.

Comparison to Other Tools

There is a rich ecosystem for running structural biology tools, and Foldy is not the right structural biology wrapper for everyone! Please review the Foldy paper for a comparison to other useful structural biology tool wrappers.

Acknowledgements

Foldy is built on the work of many open-source projects and databases. We are grateful to the developers and maintainers of:

Structure Prediction & Modeling

  • AlphaFold - Deep learning system for protein structure prediction
  • Boltz - Generative protein–ligand interaction modeling
  • ESM2 - Evolutionary Scale Modeling protein language models (Meta FAIR)
  • ESM C - Protein representation models (EvolutionaryScale)

Molecular Docking

  • AutoDock Vina - Molecular docking and virtual screening (CCSB/Scripps Research)
  • DiffDock - Diffusion-based molecular docking

Protein Domain Analysis

  • Pfam Database - Protein families database (EMBL-EBI InterPro)
  • PfamScan - Tool for scanning sequences against Pfam HMMs
  • HMMER Suite - Biosequence analysis using profile hidden Markov models

Visualization

  • Mol* - Macromolecular 3D visualization library (PDBe/EMBL-EBI & RCSB PDB)

Cheminformatics

  • RDKit - Cheminformatics and machine learning toolkit

Web Framework & Libraries

  • Flask - Python web framework
  • Plotly - Interactive graphing library
  • PyTorch - Machine learning framework

We thank all contributors and maintainers of these projects!

Use of the third-party software, libraries or code Foldy may be governed by separate terms and conditions or license provisions. Your use of the third-party software, libraries or code is subject to any such terms and you should check that you can comply with any applicable restrictions or terms and conditions before use.

License

Foldy is distributed under a modified BSD license (see LICENSE).

Copyright Notice

Foldy Copyright (c) 2023 to 2025, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy) and University of California, Berkeley. All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at [email protected].

NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.

About

Internal foldy

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •