Duello
Virial Coefficient and Dissociation Constant Estimation for Rigid Macromolecules
- Quick Start
- Installation
- Overview
- Commands
- Input Formats
- Tuning and Options
- Interaction Models
- Theory
- Examples
- Development
Install via pip:
pip install duelloRun a two-body scan between two lysozyme molecules, starting directly from a PDB file:
duello scan \
--mol1 4lzt.pdb \
--mol2 4lzt.pdb \
--rmin 24 --rmax 80 --dr 0.5 \
--molarity 0.05This computes the potential of mean force w(R) and reports the second virial coefficient B2 and dissociation constant Kd.
The output is written to pmf.dat by default.
Duello automatically coarse-grains PDB/CIF structures using the Calvados 3 force field at pH 7.0. To override these defaults:
duello scan \
--mol1 4lzt.pdb --mol2 4lzt.pdb \
--rmin 24 --rmax 80 --dr 0.5 \
--molarity 0.05 \
--ph 4.5 --model calvados3 --cg multiBinary packages are available through PyPI:
pip install duelloAlternatively, build from source with a Rust toolchain:
cargo install --git https://github.com/mlund/duelloDuello calculates the potential of mean force (PMF) between two rigid bodies by explicitly evaluating the partition function over inter-molecular orientations on a subdivided icosphere mesh.
For each mass center separation R, the angular partition function is:
yielding the potential of mean force:
and the thermally averaged energy:
where
From w(R), duello derives the osmotic second virial coefficient B2 and, for net-attractive systems, the dissociation constant Kd. See Theory for the full expressions.
Duello provides three subcommands:
| Command | Purpose |
|---|---|
duello scan |
6D scan between two rigid bodies; computes w(R), B2, Kd |
duello atom-scan |
3D scan between a rigid body and a single atom type |
duello diffusion |
Rotational diffusion analysis from a saved 6D energy table |
The primary command. Scans all inter-molecular orientations at each mass center separation to compute w(R), B2, and Kd.
From PDB/CIF (simplest):
duello scan \
--mol1 4lzt.pdb --mol2 4lzt.pdb \
--rmin 24 --rmax 80 --dr 0.5 \
--molarity 0.05From pre-generated XYZ (full control):
duello scan \
--mol1 cppm-p18.xyz --mol2 cppm-p18.xyz \
--rmin 37 --rmax 50 --dr 0.5 \
--top topology.yaml \
--max-ndiv 3 \
--cutoff 30 \
--molarity 0.05 \
--temperature 298.15 \
--backend auto \
--grid "type=powerlaw2,size=200,shift=true"| Flag | Default | Description |
|---|---|---|
-1, --mol1 |
(required) | First structure (PDB, CIF, or XYZ) |
-2, --mol2 |
(required) | Second structure (PDB, CIF, or XYZ) |
--rmin, --rmax, --dr |
(required) | Radial scan range and step size (angstrom) |
-a, --top |
-- | Topology YAML (required for XYZ, auto-generated for PDB/CIF) |
-M, --molarity |
0.1 | 1:1 salt concentration (mol/L) |
-T, --temperature |
298.15 | Temperature (K) |
--cutoff |
30.0 | Short-range spline cutoff (angstrom) |
--sr-cutoff |
= --cutoff |
Fine-tuned SR potential range (angstrom) |
--max-ndiv |
3 | Icosphere subdivision level (see Angular Resolution) |
--gradient-threshold |
0.5 | Adaptive resolution threshold (1/rad) |
--backend |
auto | Compute backend: auto, gpu, simd, reference |
--grid |
(see below) | Spline grid settings (see Spline Grid) |
--pmf |
pmf.dat | Output PMF file |
--savetable |
-- | Save 6D binary table (.bin.gz for compression) |
--fixed-dielectric |
-- | Override dielectric constant |
PDB/CIF-only options:
| Flag | Default | Description |
|---|---|---|
--ph |
7.0 | pH for coarse-graining |
--model |
calvados3 | Force field model |
--cg |
single | Coarse-graining policy: single or multi |
--scale-hydrophobic |
-- | Hydrophobic scaling, e.g. lambda:1.2 or epsilon:0.8 |
--chain |
(all) | Keep only these chain IDs (repeatable: --chain A --chain B) |
Computes a 3D energy table (R, theta, phi) between a rigid body and a single test atom type. Useful for rigid body + mobile ion simulations where the full 6D scan is unnecessary.
duello atom-scan \
--mol1 4lzt.xyz \
--atom Na \
--rmin 2.0 --rmax 60 --dr 0.5 \
--top topology.yaml \
--molarity 0.02 \
--cutoff 150The output is a flat binary table (Table3DFlat) with barycentric interpolation on the icosphere mesh.
| Flag | Default | Description |
|---|---|---|
--mol1 |
(required) | Rigid body structure |
--atom |
(required) | Atom type name (from topology) |
-o, --output |
atom_table.bin.gz | Output binary table |
--pmf |
pmf.dat | Output PMF file |
All other radial, topology, backend, and PDB/CIF flags are shared with duello scan.
Note: This subcommand is experimental. Output format and methods may change in future releases.
Estimates the normalized rotational diffusion coefficient D_r / D_r^0 from a previously saved 6D energy table, without re-scanning. Two methods are used:
- Zwanzig formula -- transport coefficient from energy landscape roughness
- Spectral gap -- slowest relaxation rate from sparse Lanczos eigendecomposition
duello diffusion table.bin.gz \
-T 300 \
-o diffusion.csv \
-j 4The temperature can differ from the scan temperature since energies are stored in absolute units (kJ/mol).
| Flag | Default | Description |
|---|---|---|
<TABLE> |
(required) | Path to 6D binary table (.bin or .bin.gz) |
-T |
298.15 | Temperature (K) |
-o |
diffusion.csv | Output CSV |
-j |
0 (all cores) | Thread count (fewer = less memory) |
--cmin/--cmax |
-- | Concentration scan range (mol/L) |
--cn |
20 | Number of concentration points |
--cell-output |
cell_diffusion.csv | Output CSV for cell-model D(c) |
--export-matrices |
-- | Export generator matrices (Matrix Market) |
| Column | Description |
|---|---|
R |
Mass center separation (angstrom) |
D/D^0 |
Normalized rotational diffusion (Zwanzig, full 5D). 1 = free, 0 = locked |
D_A/D_A^0 |
Per-molecule-A Zwanzig (marginalized over B and dihedral) |
D_B/D_B^0 |
Per-molecule-B Zwanzig (marginalized over A and dihedral) |
D_w/D_w^0 |
Per-dihedral Zwanzig (marginalized over both molecules) |
separability |
D/D^0 / (D_A x D_B x D_w). 1 = independent, 0 = coupled |
lambda_k |
Eigenvalue magnitude of mode k |
f_Ak, f_Bk, f_wk |
Coordinate fractions for mode k (mol A / mol B / dihedral) |
n_active |
Number of finite-energy grid points at this R |
Interpretation: D/D^0 near 1 means nearly free rotation; values near 0 indicate a rugged energy landscape that locks orientations. The separability column reveals whether molecular rotations are independent or coupled. For homo-dimers, D_A ~ D_B by symmetry.
Pass PDB or CIF files directly. Duello coarse-grains them on the fly using cgkitten, generating .xyz and _topology.yaml files alongside the input. Charges are computed using Monte Carlo titration.
If your PDB has missing atoms or residues, pre-process with pdbfixer:
pip install pdbfixer
pdbfixer 4lzt.pdb --add-atoms=all --add-residuesFor XYZ input, a topology file (--top) must be provided. You can generate XYZ and topology files from PDB using cgkitten:
cargo install cgkitten
cgkitten 4lzt.pdb convert --ph 7.0The topology is a YAML file defining atom properties and the pair potential. Example:
atoms:
- {name: ALA, charge: 0.0, mass: 71.07, Ο: 5.04, Ξ΅: 0.8368, hydrophobicity: !Lambda 0.34}
- {name: LYS, charge: 1.0, mass: 128.17, Ο: 6.36, Ξ΅: 0.8368, hydrophobicity: !Lambda 0.14}
# ... one entry per bead type
system:
energy:
nonbonded:
# Coulomb/Yukawa is always added automatically -- do NOT specify it here
default:
- !AshbaughHatch {mixing: arithmetic, cutoff: 20.0}Each atom entry defines charge, mass, Lennard-Jones-like size (sigma) and well depth (epsilon), and model-specific properties.
The nonbonded section specifies the short-range pair potential; different potentials can be assigned to specific atom pairs if needed.
Warning: The electrostatic Coulomb/Yukawa term is always added automatically. Do not include it in the topology.
The --max-ndiv flag sets the icosphere subdivision level, controlling angular mesh density:
--max-ndiv |
Vertices | Approx. angular spacing |
|---|---|---|
| 0 | 12 | 1.0 rad |
| 1 | 42 | 0.55 rad |
| 2 | 92 | 0.37 rad |
| 3 (default) | 162 | 0.28 rad |
Higher levels give more accurate angular integration at the cost of more energy evaluations per radial slice.
Duello automatically classifies each radial slab into tiers based on the angular energy gradient:
| Tier | Description |
|---|---|
| Repulsive | All Boltzmann weights negligible; zero storage, returns infinity |
| Scalar | Nearly isotropic surface; collapsed to a single value |
| Nearest-vertex | Smooth surface; nearest-vertex lookup, no interpolation |
| Interpolated | Full barycentric interpolation on icosphere faces |
The --gradient-threshold flag (default: 0.5 1/rad) controls when resolution is reduced. A summary is printed after table generation.
The --cutoff flag (default 30 angstrom) sets the spline range for short-range pair potentials in GPU/SIMD backends. Beyond this distance the spline returns zero.
It does not affect the analytical Coulomb/Yukawa evaluation, which has no cutoff.
Important rules:
--cutoffmust be >= the largest cutoff defined in the topology (otherwise the spline silently truncates the potential).- Setting
--cutoffmuch larger than needed wastes spline points but is otherwise harmless. - Use
--sr-cutoffto match the actual SR potential range for best accuracy (e.g.--sr-cutoff 20when AshbaughHatch has cutoff 20). - The
referencebackend ignores--cutoffand evaluates potentials with their native cutoffs.
The --grid flag controls spline interpolation of short-range potentials (GPU/SIMD backends):
| Key | Values | Default | Description |
|---|---|---|---|
type |
powerlaw2, invr2 |
powerlaw2 |
Grid spacing (invr2 avoids sqrt in lookup) |
size |
integer | 200 |
Number of grid points |
shift |
true, false |
true |
Shift energy to zero at cutoff |
energy_cap |
float or none |
none |
Cap repulsive wall (kJ/mol) for f32 precision |
Example: --grid "type=invr2,size=1000,shift=false,energy_cap=50"
Duello automatically selects the best available backend. Performance on the Calvados3 lysozyme benchmark (2.4M poses, 128 atoms/molecule, Apple M4):
| Backend | Description | Poses/ms | Speedup |
|---|---|---|---|
reference |
Exact potentials (validation) | 48 | 1.0x |
simd |
NEON (aarch64) / AVX2 (x86) | 131 | 2.7x |
gpu |
wgpu compute shaders | 1065 | 22x |
auto (default) selects GPU if available, otherwise SIMD.
GPU and SIMD backends use cubic Hermite splines for short-range potentials and evaluate Coulomb/Yukawa analytically.
Each macromolecule is represented by a rigid constellation of beads with properties defined in the topology.
The inter-molecular energy
Provided examples use:
- Calvados 3: Screened Coulomb + AshbaughHatch
- CPPM: Screened Coulomb + WeeksChandlerAndersen
Many additional pair potentials are available through the interatomic library (LennardJones, HardSphere, etc.).
Different pair potentials can be assigned to specific atom pairs in the topology.
The osmotic second virial coefficient reports on two-body interactions:
where
For systems with net attractive interactions, the dissociation constant is estimated by:
The rotational diffusion coefficient is estimated via the Zwanzig formula:
where the averages are over the 5D angular grid.
Ready-to-run examples are provided in scripts/ and examples/:
| Path | Description |
|---|---|
scripts/cppm.sh |
Spherical, multipolar particles using the CPPM model |
scripts/calvados3.sh |
Two coarse-grained lysozyme molecules with Calvados 3 |
A Google Colab notebook is also available:
Run on macOS, Linux (x86 and arm) to cover all architectures:
docker run --rm -v $(pwd):/io ghcr.io/pyo3/maturin:v1.11.5 publish -u __token__ -p PYPI_TOKENpip install ziglang pipx
pipx install maturin
maturin publish -u __token__ -p PYPI_TOKEN --target=x86_64-unknown-linux-gnu --zigmacOS targets can be built without --zig:
rustup target add x86_64-apple-darwin aarch64-apple-darwin
maturin publish -u __token__ -p PYPI_TOKEN --target=aarch64-apple-darwin
