Skip to main content

Module contract

Module contract 

Source
Expand description

What an analysis assumed, and what it is therefore worth.

Every analysis takes a policy and returns a value plus its coverage, its status, its warnings and its provenance. Decisions that are otherwise silent defaults — which assembly, which model, which conformation, which identifier namespace, what to do about atoms that were never modelled — become data that can be inspected, fingerprinted, varied and published.

Structs§

AlgorithmId
Stable name and version of the algorithm that produced a result.
Analysis
A value, and everything needed to judge it.
AnalysisPolicy
Every semantic decision an analysis depends on.
Assumption
One decision made on the caller’s behalf.
Coverage
How much of what an analysis meant to use it actually used.
DictionaryVersion
The version of a body of reference data.
Fingerprint
A stable content fingerprint.
ProfileId
The name and version of a policy profile.
Provenance
Everything needed to reproduce a result.
Reexecution
A value recomputed under an exactly validated provenance record.
ReexecutionEnvironment
Versions of executable and reference data available for a re-execution.
Tolerance
How close two floating-point values must be to count as equal.

Enums§

AlignmentPolicy
How two structures are put into correspondence before comparison.
AltlocPolicy
How to resolve alternate conformations.
AssemblyChoice
Which arrangement of the contents to analyse.
AssumptionSource
Where a decision came from.
ContactDefinition
What counts as a contact.
EquivalencePolicy
How two atoms are decided to correspond.
HydrogenPolicy
How hydrogens enter a calculation.
ImpactEstimate
How much a decision could have changed the answer.
MissingPolicy
What to do about atoms a component should have but the model does not.
ModelChoice
Which model to analyse.
Namespace
Which identifier namespace an unqualified selector means.
ParameterValue
A typed, deterministic result-affecting algorithm parameter.
PeriodicPolicy
How periodic boundaries are handled.
PolicyField
Which field of a policy something refers to.
Precision
The width accumulation runs at.
RadiiSet
Which published set of van der Waals radii to use.
ReexecutionError
Reason exact re-execution was refused.
SourceRef
Where an input came from.
Status
How far an analysis got.
SymmetryPolicy
Whether symmetry copies participate.

Functions§

reexecute_from_provenance
Recomputes a value only after reproducing every recorded deterministic input.

Type Aliases§

AnalysisParameters
Sorted algorithm parameters that participate in provenance fingerprints.