Prototype ApherisFold CLI for Hub-backed customer demos.
Project description
ApherisFold CLI
Command-line interface for submitting and managing prediction, benchmark, and fine-tuning workflows on an Apheris Hub instance.
Requirements
- Python 3.10 or later
- Access to an Apheris Hub instance
Installation
conda
Recommended if you already use conda for scientific Python work. A dedicated environment avoids dependency conflicts.
Linux / macOS
conda create -n apherisfold python=3.11 -y
conda activate apherisfold
pip install apherisfold-cli
Windows (Anaconda Prompt or PowerShell)
conda create -n apherisfold python=3.11 -y
conda activate apherisfold
pip install apherisfold-cli
Activate the environment at the start of each session with conda activate apherisfold.
venv (standard Python)
Linux / macOS (venv)
python3 -m venv ~/.venvs/apherisfold
source ~/.venvs/apherisfold/bin/activate
pip install apherisfold-cli
Windows (PowerShell, venv)
python -m venv $env:USERPROFILE\.venvs\apherisfold
& $env:USERPROFILE\.venvs\apherisfold\Scripts\Activate.ps1
pip install apherisfold-cli
Activate the environment at the start of each session with the activate command above.
Verify
apherisfold --version
apherisfold --help
Upgrade
pip install --upgrade apherisfold-cli
Quick start
# Log in with your ApherisFold Hub URL
apherisfold login --url https://hub.example.com
# See available models and weights
apherisfold weights list
# Submit a prediction
apherisfold workflow predict run \
--model openfold3 \
--weight 3.0.0 \
--input ./request.json
# By default, local artifacts are written under ./.apherisfold/runs/<workflow>/<id>
# relative to the directory where you run the command. Use --output to choose another directory.
# List submitted jobs
apherisfold workflow predict list
# Inspect a job
apherisfold workflow predict get --id job_NUlyMsnWq
Workflows
| Workflow | Entry point |
|---|---|
| Structure prediction | apherisfold workflow predict run |
| Benchmarking | apherisfold workflow benchmark run |
| Fine-tuning | apherisfold workflow fine-tune prepare |
Affinity prediction
When using weights that support affinity prediction, the CLI selects the ligand chain automatically if there is only one. For queries with multiple ligand chains, specify which one to score with --affinity-ligand:
apherisfold workflow predict run \
--model openfold3 \
--weight 3.0.0 \
--input ./request.json \
--affinity-ligand B
Use --help on any subcommand for the full option reference and examples:
apherisfold workflow predict run --help
apherisfold workflow benchmark run --help
apherisfold workflow fine-tune prepare --help
Support
Contact support@apheris.com for access and deployment assistance.
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 Distributions
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 apherisfold_cli-0.1.11-py3-none-any.whl.
File metadata
- Download URL: apherisfold_cli-0.1.11-py3-none-any.whl
- Upload date:
- Size: 81.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07d054ff314bef97c5ef187e8aeb6ff459df4490f24cf75e9a855853b3083ae4
|
|
| MD5 |
05d98a2a85a9a6208b1133a1ab48f553
|
|
| BLAKE2b-256 |
2dfc0ae827b2b88f7faa1b806f2e1011fd445103130a99c8ff456d44ffe14d8a
|
Provenance
The following attestation bundles were made for apherisfold_cli-0.1.11-py3-none-any.whl:
Publisher:
publish-apherisfold-pypi.yaml on apheris/hub
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
apherisfold_cli-0.1.11-py3-none-any.whl -
Subject digest:
07d054ff314bef97c5ef187e8aeb6ff459df4490f24cf75e9a855853b3083ae4 - Sigstore transparency entry: 2024102176
- Sigstore integration time:
-
Permalink:
apheris/hub@91ea2a171be91ac0465e15afc7d82e2014340b94 -
Branch / Tag:
refs/pull/2387/merge - Owner: https://github.com/apheris
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-apherisfold-pypi.yaml@91ea2a171be91ac0465e15afc7d82e2014340b94 -
Trigger Event:
pull_request
-
Statement type: