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§
- Algorithm
Id - Stable name and version of the algorithm that produced a result.
- Analysis
- An outcome, and everything needed to judge it.
- Analysis
Policy - Every semantic decision an analysis depends on.
- Assumption
- One decision made on the caller’s behalf.
- Content
Digest - The SHA-256 digest of a block of bytes.
- Coverage
- How much of what an analysis meant to use it actually used.
- Dictionary
Version - The version of a body of reference data.
- Fingerprint
- A fast, stable 64-bit fingerprint of a policy, a record or a cache entry.
- Measured
Impact - The measured effect of one decision on one analysis.
- Policy
Parse Error - A named choice (a policy decision, a spatial backend, a file format) was spelled with a word outside its vocabulary.
- Profile
Id - 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.
- Reexecution
Environment - 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§
- Alignment
Policy - How two structures are put into correspondence before comparison.
- Altloc
Policy - How to resolve alternate conformations.
- Assembly
Choice - Which arrangement of the contents to analyse.
- Assumption
Source - Where a decision came from.
- Contact
Definition - What counts as a contact.
- Equivalence
Policy - How two atoms are decided to correspond.
- Hydrogen
Policy - How hydrogens enter a calculation.
- Impact
- How much a decision changed the answer, where that is known.
- Indeterminacy
- Why no defensible answer exists under a policy.
- Missing
Policy - What to do about atoms a component should have but the model does not.
- Missing
Policy Error - Why a missing-input policy could not be applied.
- Model
Choice - Which model to analyse.
- Namespace
- Which identifier namespace an unqualified selector means.
- Outcome
- A value, or the reason there is none.
- Parameter
Value - A typed, deterministic result-affecting algorithm parameter.
- Periodic
Policy - How periodic boundaries are handled.
- Policy
Field - Which field of a policy something refers to.
- Precision
- The width accumulation runs at.
- Quality
- How complete a determinate answer is.
- Radii
Set - Which published set of van der Waals radii to use.
- Reexecution
Error - Reason exact re-execution was refused.
- Source
Ref - Where an input came from.
- Status
- How far an analysis got.
- Symmetry
Policy - Whether symmetry copies participate.
Functions§
- canonical_
spelling valuewith underscores read as hyphens, the spelling every vocabulary compares against.- push_
json_ string - Appends
valuetooutputas a JSON string literal. - reexecute_
from_ provenance - Recomputes a value only after reproducing every recorded deterministic input.
- resolve_
missing - What the policy for missing inputs makes of a value computed over
coverage.
Type Aliases§
- Analysis
Parameters - Sorted algorithm parameters that participate in provenance fingerprints.