prothon compare --ensembles wild_type.dcd mutant.dcd --topology topology.pdb
CBCN (reference: ensemble 0)
ensemble 1: d = 0.2841 (floor 0.0472) — 34/76 residues differ
Two numbers, and the second is the one that decides whether the first means anything. Split one ensemble in half at random and compare the halves: the answer is not zero, because a finite sample never reproduces a continuous distribution exactly. That self-distance is the noise floor — the smallest difference this much sampling can resolve.
Here 0.2841 clears a floor of 0.0472 by six times. At 0.05 it would not have, and Prothon would say so rather than report a small difference.
Install
conda create -n prothon -c conda-forge prothon
conda activate prothon
prothon info lists what is installed and what version:
prothon info
What you can compare
| Two conditions, one protein | Bound against free, folded against unfolded, one force field against another. Per residue, with a p-value, and a floor beside every value. |
| Two different molecules | Mutant against wild type, or a construct against a longer one. Superposition needs a common coordinate frame and two different molecules have none; a residue map from a sequence alignment is enough. |
| A simulation against a deposited ensemble | PED accessions by name (PED00024), multi-model PDB, directories of structures, and every common trajectory format — on equal terms in one command. |
| Several models against one reference | --report table ranks them by the margin above each model's own floor rather than by raw distance, because a thinly sampled ensemble scores a smaller distance for being thinly sampled. |
| A trajectory against itself | How much of it is independent, how long it must run before a difference of a given size can be resolved, and whether its correlation time has settled. |
| An ensemble against experiment | Rg, end-to-end distance, PRE, FRET and ³J — each beside a floor, because a perfect ensemble of twenty conformations scores χ²_red = 0.77 and fitting that to 1.0 is fitting to noise. |
| What no per-residue statistic can see | Two ensembles can match residue by residue and differ in how residues move together. MMD and a classifier two-sample test find that; the classifier names the residues carrying it. |
| Missed states against invented ones | Precision and recall per residue. A symmetric distance says two ensembles differ; these say which one is short of a state and which has one too many. |
It withholds rather than overstates. Trajectory frames are not independent draws, and a test that assumes they are calls 99% of residues different when nothing differs. Prothon estimates the correlation time from your data, permutes contiguous blocks of it, and holds a false-positive rate between 1.7% and 2.3% across correlation times spanning a factor of fifty. Where a trajectory holds too few independent blocks to build a null from, it reports the floor and prints no p-value at all. Every default is a measurement, not a choice.
One import, and everything is reachable from it
from prothon import Prothon
prothon = Prothon(["wild_type.dcd", "mutant.dcd"], "topology.pdb", "cbcn",
random_state=0)
prothon.compare() # where do they differ
prothon.distinguishability() # differences *between* residues
prothon.coverage_and_fidelity() # missed states, or invented ones
prothon.rank() # several against a reference
prothon.validate("rg", [2.71], [0.08]) # against experiment
prothon.save_config() # writes prothon.yml
The order parameter is a property of the study, so it is named once. Any method takes one to override it for a single call.
Three ways to run the same study, and none is a subset of another — flags, file and API are generated from one schema:
| The CLI | prothon compare --ensembles wt.dcd mut.dcd --topology top.pdb --order-parameters cbcn, or a flag for any setting. Every long flag has a short form. |
| A config file | prothon compare --config prothon.yml. A study written down can be committed beside a manuscript, diffed when it changes, and re-run by someone who has the data but not the terminal session. |
| The Python API | Prothon(...), or Prothon(study="prothon.yml"). |
Any command line can be written out as a file with --save-config, and any
file can be run from the command line.
Documentation
Start here — Install · Your first comparison · Order parameters · Worked examples
Going further — The statistics · Different molecules · Distances · Scoring against experiment · Ranking several ensembles
Measurements — Calibration · Circular parameters · Convergence · Ubiquitin · Performance
Reference — CLI · Configuration · Python API
Citation
Aina, A.; Hsueh, S. C. C.; Plotkin, S. S. PROTHON: A Local Order Parameter-Based Method for Efficient Comparison of Protein Ensembles. J. Chem. Inf. Model. 2023, 63, 3453–3461. DOI: 10.1021/acs.jcim.3c00145
@article{aina2023prothon,
author = {Aina, Adekunle and Hsueh, Shawn C. C. and Plotkin, Steven S.},
title = {PROTHON: A Local Order Parameter-Based Method for Efficient
Comparison of Protein Ensembles},
journal = {Journal of Chemical Information and Modeling},
volume = {63},
number = {11},
pages = {3453--3461},
year = {2023},
doi = {10.1021/acs.jcim.3c00145},
}
Contributing
Contributions welcome — see CONTRIBUTING.md.
License
MIT. See LICENSE.
Built in the AAI Research Lab at California State University Dominguez Hills, on MDTraj, NumPy, SciPy, scikit-learn and Matplotlib.
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 prothon_ensembles-2.3.2.tar.gz.
File metadata
- Download URL: prothon_ensembles-2.3.2.tar.gz
- Upload date:
- Size: 280.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db2c7ee1063b53c8a4626fe4eb9ba9db1a085bf806367c76c224970084a33c47
|
|
| MD5 |
c1cfe2a0ff8e7337e13d36b209076a9b
|
|
| BLAKE2b-256 |
18fb63db141076970dde3afa50e06a7d34f6adb28cb38693e85fb9b1a5f40b70
|
Provenance
The following attestation bundles were made for prothon_ensembles-2.3.2.tar.gz:
Publisher:
publish.yml on aai-research-lab/Prothon
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prothon_ensembles-2.3.2.tar.gz -
Subject digest:
db2c7ee1063b53c8a4626fe4eb9ba9db1a085bf806367c76c224970084a33c47 - Sigstore transparency entry: 2681757009
- Sigstore integration time:
-
Permalink:
aai-research-lab/Prothon@3ed5ebab6e4e660693824a95b11fa7e3fbc50b25 -
Branch / Tag:
refs/tags/v2.3.2 - Owner: https://github.com/aai-research-lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3ed5ebab6e4e660693824a95b11fa7e3fbc50b25 -
Trigger Event:
push
-
Statement type:
File details
Details for the file prothon_ensembles-2.3.2-py3-none-any.whl.
File metadata
- Download URL: prothon_ensembles-2.3.2-py3-none-any.whl
- Upload date:
- Size: 134.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25f445e5472ffd398a600aeacbe5bc813946a82668cc9a96b466c952b5a550e4
|
|
| MD5 |
9d7babd208f5d47872ec7e7617eff8f7
|
|
| BLAKE2b-256 |
cd7f52c9caf2760f009f22f2088bd9c63c9af23bff0d2147529c78cd47ecf058
|
Provenance
The following attestation bundles were made for prothon_ensembles-2.3.2-py3-none-any.whl:
Publisher:
publish.yml on aai-research-lab/Prothon
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prothon_ensembles-2.3.2-py3-none-any.whl -
Subject digest:
25f445e5472ffd398a600aeacbe5bc813946a82668cc9a96b466c952b5a550e4 - Sigstore transparency entry: 2681757047
- Sigstore integration time:
-
Permalink:
aai-research-lab/Prothon@3ed5ebab6e4e660693824a95b11fa7e3fbc50b25 -
Branch / Tag:
refs/tags/v2.3.2 - Owner: https://github.com/aai-research-lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3ed5ebab6e4e660693824a95b11fa7e3fbc50b25 -
Trigger Event:
push
-
Statement type: