Enhanced sampling API#
The enhanced sampling API adds biases and replica exchange to a dynamics run.
EnhancedSampling builds the engine. A bias is an additive potential
that the engine sums against the unmodified model output.
See also
The enhanced sampling user guide for the workflow, choice of bias, and worked examples.
Engine#
Declarative recipe for biased dynamics on a |
|
One set of conditions a walker can be assigned to. |
|
Synchronous replica exchange with an even/odd pair schedule. |
Bias contract and hooks#
A bias defined by a differentiable energy. |
|
Mixin for a bias whose state changes as sampling proceeds. |
|
Evaluate every bias against one unmodified model output, then apply. |
|
Fire |
|
Stamp walker identity and step counters onto the live batch. |
Built-in biases#
Multi-dimensional harmonic restraint on one or more collective variables. |
|
Penalise the CV for rising above a threshold. |
|
Penalise the CV for falling below a threshold. |
|
Confine the CV to an interval, with no force inside it. |
|
Gaussian hills deposited along a CV, with well-tempered damping. |
|
Repulsive Gaussian bias over retained reference structures. |
|
Estimate and cancel the mean force along a pair distance. |
Collective variables#
Return the displacement between two atoms per graph, shape |
|
Differentiable pair distance(s) as a collective variable. |
|
Return |