QCElemental API

qcelemental Package

Functions

compare(expected, computed[, label, ...])

Returns True if two integers, strings, booleans, or integer arrays are element-wise equal.

compare_recursive(expected, computed[, ...])

Recursively compares nested structures such as dictionaries and lists.

compare_values(expected, computed[, label, ...])

Returns True if two floats or float arrays are element-wise equal within a tolerance.

Classes

ChoicesError(msg[, choices])

Error called for problems with syntax input file.

CovalentRadii([context])

Covalent radii sets.

DataUnavailableError(dataset, atom)

Error when dataset incomplete and otherwise valid query can't be fulfilled.

Datum

Facilitates the storage of quantum chemical results by labeling them with basic metadata.

MoleculeFormatError(msg)

Error called when a molparse.from_string contains unparsable lines.

NotAnElementError(atom[, strict])

Error when element or nuclide can't be identified.

PhysicalConstantsContext([context])

CODATA physical constants set from NIST.

ValidationError(msg)

Error called for problems with syntax input file.

VanderWaalsRadii([context])

Van der Waals radii sets.

Variables

constants

CODATA physical constants set from NIST.

covalentradii

Covalent radii sets.

periodictable

Nuclear and mass data about chemical elements from NIST.

vdwradii

Van der Waals radii sets.

Class Inheritance Diagram

digraph inheritance3e7a5ab12f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Representation" -> "BaseModel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ChoicesError" [URL="api/qcelemental.ChoicesError.html#qcelemental.ChoicesError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error called for problems with syntax input file. Prints"]; "CovalentRadii" [URL="api/qcelemental.CovalentRadii.html#qcelemental.CovalentRadii",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Covalent radii sets."]; "DataUnavailableError" [URL="api/qcelemental.DataUnavailableError.html#qcelemental.DataUnavailableError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error when dataset incomplete and otherwise valid query can't be fulfilled."]; "Datum" [URL="api/qcelemental.Datum.html#qcelemental.Datum",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Facilitates the storage of quantum chemical results by labeling them with basic metadata."]; "BaseModel" -> "Datum" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MoleculeFormatError" [URL="api/qcelemental.MoleculeFormatError.html#qcelemental.MoleculeFormatError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error called when a molparse.from_string contains unparsable lines."]; "NotAnElementError" [URL="api/qcelemental.NotAnElementError.html#qcelemental.NotAnElementError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error when element or nuclide can't be identified."]; "PhysicalConstantsContext" [URL="api/qcelemental.PhysicalConstantsContext.html#qcelemental.PhysicalConstantsContext",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="CODATA physical constants set from NIST."]; "Representation" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Mixin to provide __str__, __repr__, and __pretty__ methods. See #884 for more details."]; "ValidationError" [URL="api/qcelemental.ValidationError.html#qcelemental.ValidationError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error called for problems with syntax input file. Prints"]; "VanderWaalsRadii" [URL="api/qcelemental.VanderWaalsRadii.html#qcelemental.VanderWaalsRadii",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Van der Waals radii sets."]; }

qcelemental.molparse Package

Functions

contiguize_from_fragment_pattern(frag_pattern, *)

Take (nat, ?) array-like arrays and return with atoms arranged by (nfr, ?) frag_pattern.

from_arrays(*[, geom, elea, elez, elem, ...])

Compose a Molecule dict from unvalidated arrays and variables, returning dict.

from_input_arrays(*[, enable_qm, ...])

Compose a Molecule dict from unvalidated arrays and variables in multiple domains.

from_schema(molschema, *[, nonphysical, verbose])

Construct molecule dictionary representation from non-Psi4 schema.

from_string(molstr[, dtype, name, fix_com, ...])

Construct a molecule dictionary from any recognized string format.

parse_nucleus_label(label)

Separate molecule nucleus string into fields.

reconcile_nucleus([A, Z, E, mass, real, ...])

Forms consistent set of nucleus descriptors from all information from arguments, supplemented by the periodic table.

to_schema(molrec, dtype[, units, np_out, copy])

Translate molparse internal Molecule spec into dictionary from other schemas.

to_string(molrec, dtype[, units, ...])

Format a string representation of QM molecule.

validate_and_fill_chgmult(zeff, ...[, ...])

Forms molecular and fragment charge and multiplicity specification by completing and reconciling information from argument, supplemented by physical constraints and sensible defaults.

qcelemental.molutil Package

Functions

B787(cgeom, rgeom, cuniq, runiq[, do_plot, ...])

Use Kabsch algorithm to find best alignment of geometry cgeom onto rgeom while sampling atom mappings restricted by runiq and cuniq.

compute_scramble(nat[, do_resort, do_shift, ...])

Generate a random or directed translation, rotation, and atom shuffling.

guess_connectivity(symbols, geometry[, ...])

Finds connected atoms based off of a covalent radii metric.

kabsch_align(rgeom, cgeom[, weight])

Finds optimal translation and rotation to align cgeom onto rgeom via Kabsch algorithm by minimizing the norm of the residual, \(|| R - U * C ||\).

molecular_formula_from_symbols(symbols[, order])

Returns the molecular formula for a list of symbols.

order_molecular_formula(formula[, order])

Reorders a molecular formula.

qcelemental.testing Module

Functions

compare(expected, computed[, label, ...])

Returns True if two integers, strings, booleans, or integer arrays are element-wise equal.

compare_molrecs(expected, computed[, label, ...])

Function to compare Molecule dictionaries.

compare_recursive(expected, computed[, ...])

Recursively compares nested structures such as dictionaries and lists.

compare_values(expected, computed[, label, ...])

Returns True if two floats or float arrays are element-wise equal within a tolerance.

qcelemental.models Package

Classes

AlignmentMill

Facilitates the application of the simple transformation operations defined by shift, rotation, atommap arrays and mirror boolean as recipe to the data structures describing Cartesian molecular coordinates.

AtomicInput

The MolSSI Quantum Chemistry Schema

AtomicResult

Results from a CMS program execution.

AtomicResultProperties

Named properties of quantum chemistry computations following the MolSSI QCSchema.

AutodocBaseSettings

BasisSet

A quantum chemistry basis description.

ComputeError

Complete description of the error from an unsuccessful program execution.

DriverEnum(value)

Allowed computation driver values.

FailedOperation

Record indicating that a given operation (program, procedure, etc.) has failed and containing the reason and input data which generated the failure.

Molecule

The physical Cartesian representation of the molecular system.

OptimizationInput

OptimizationResult

ProtoModel

Provenance

Provenance information.

Result

QC Result Schema.

ResultInput

QC Input Schema.

ResultProperties

QC Result Properties Schema.

Class Inheritance Diagram

digraph inheritance8e50962132 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AlignmentMill" [URL="api/qcelemental.models.AlignmentMill.html#qcelemental.models.AlignmentMill",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Facilitates the application of the simple transformation operations"]; "ProtoModel" -> "AlignmentMill" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AtomicInput" [URL="api/qcelemental.models.AtomicInput.html#qcelemental.models.AtomicInput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The MolSSI Quantum Chemistry Schema"]; "ProtoModel" -> "AtomicInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AtomicResult" [URL="api/qcelemental.models.AtomicResult.html#qcelemental.models.AtomicResult",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Results from a CMS program execution."]; "AtomicInput" -> "AtomicResult" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AtomicResultProperties" [URL="api/qcelemental.models.AtomicResultProperties.html#qcelemental.models.AtomicResultProperties",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Named properties of quantum chemistry computations following the MolSSI QCSchema."]; "ProtoModel" -> "AtomicResultProperties" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AutodocBaseSettings" [URL="api/qcelemental.models.AutodocBaseSettings.html#qcelemental.models.AutodocBaseSettings",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseSettings" -> "AutodocBaseSettings" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Representation" -> "BaseModel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseSettings" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for settings, allowing values to be overridden by environment variables."]; "BaseModel" -> "BaseSettings" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BasisSet" [URL="api/qcelemental.models.BasisSet.html#qcelemental.models.BasisSet",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A quantum chemistry basis description."]; "ProtoModel" -> "BasisSet" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ComputeError" [URL="api/qcelemental.models.ComputeError.html#qcelemental.models.ComputeError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Complete description of the error from an unsuccessful program execution."]; "ProtoModel" -> "ComputeError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DriverEnum" [URL="api/qcelemental.models.DriverEnum.html#qcelemental.models.DriverEnum",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Allowed computation driver values."]; "Enum" -> "DriverEnum" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Generic enumeration."]; "FailedOperation" [URL="api/qcelemental.models.FailedOperation.html#qcelemental.models.FailedOperation",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Record indicating that a given operation (program, procedure, etc.) has failed and containing the reason and input data which generated the failure."]; "ProtoModel" -> "FailedOperation" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Molecule" [URL="api/qcelemental.models.Molecule.html#qcelemental.models.Molecule",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The physical Cartesian representation of the molecular system."]; "ProtoModel" -> "Molecule" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OptimizationInput" [URL="api/qcelemental.models.OptimizationInput.html#qcelemental.models.OptimizationInput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ProtoModel" -> "OptimizationInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OptimizationResult" [URL="api/qcelemental.models.OptimizationResult.html#qcelemental.models.OptimizationResult",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "OptimizationInput" -> "OptimizationResult" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProtoModel" [URL="api/qcelemental.models.ProtoModel.html#qcelemental.models.ProtoModel",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseModel" -> "ProtoModel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Provenance" [URL="api/qcelemental.models.Provenance.html#qcelemental.models.Provenance",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Provenance information."]; "ProtoModel" -> "Provenance" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Representation" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Mixin to provide __str__, __repr__, and __pretty__ methods. See #884 for more details."]; "Result" [URL="api/qcelemental.models.Result.html#qcelemental.models.Result",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QC Result Schema."]; "AtomicResult" -> "Result" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResultInput" [URL="api/qcelemental.models.ResultInput.html#qcelemental.models.ResultInput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QC Input Schema."]; "AtomicInput" -> "ResultInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResultProperties" [URL="api/qcelemental.models.ResultProperties.html#qcelemental.models.ResultProperties",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QC Result Properties Schema."]; "AtomicResultProperties" -> "ResultProperties" [arrowsize=0.5,style="setlinewidth(0.5)"]; }