Installation
Step 1: Install the package
Proto-tools requires Python 3.10+:bash
A direct PyPI install (
pip install proto-tools) will be available soon.If you are developing or contributing to this project, follow the setup instructions in CONTRIBUTING.md instead.
Step 2: Configure storage (optional)
All persistent data (model weights and tool environments) is cached under thePROTO_HOME directory on first use (defaults to ~/.proto/).
To customize the storage location, you can specify a path via the following environment variable:
bash
PROTO_MODEL_CACHE environment variable lets you point just the weights at that shared location (sharing tool environments is not recommended): export PROTO_MODEL_CACHE=/path/to/shared/weights. See Storage guide for all details and options.
Step 3: Gated model access (optional)
Some tools use gated models that require accepting a license / terms-of-use. Two access flows depending on how the upstream author publishes weights:| Model | Source | Access |
|---|---|---|
| ESM3 | HuggingFace: EvolutionaryScale/esm3-sm-open-v1 | Accept EvolutionaryScale license, then authenticate with HF (see below) |
| AlphaGenome | HuggingFace: google/alphagenome-all-folds | Accept Google DeepMind terms, then authenticate with HF (see below) |
| AlphaFold3 | DeepMind request form: google-deepmind/alphafold3#obtaining-model-parameters | Submit DeepMind’s form; if approved, you can download the weights archive and place at $PROTO_HOME/proto_model_cache/alphafold3/ (or set PROTO_ALPHAFOLD3_WEIGHTS_DIR). See proto_tools/tools/structure_prediction/alphafold3/README.md for the full weights-setup flow. |
- Create a HuggingFace account
- Visit each model page above and accept the license/terms
- Install the HuggingFace CLI and log in:
Or set the token directly in your environment:
You’re all set! Head over to the Quickstart to run your first tool, or browse the tool catalog to see what’s available.