OptimizationInput
- pydantic model qcelemental.models.OptimizationInput[source]
QCSchema input directive for geometry optimization.
Show JSON schema
{ "title": "OptimizationInput", "description": "QCSchema input directive for geometry optimization.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "hash_index": { "title": "Hash Index", "type": "string" }, "schema_name": { "title": "Schema Name", "default": "qcschema_optimization_input", "pattern": "qcschema_optimization_input", "type": "string" }, "schema_version": { "title": "Schema Version", "default": 1, "type": "integer" }, "keywords": { "title": "Keywords", "description": "The optimization specific keywords to be used.", "default": {}, "type": "object" }, "extras": { "title": "Extras", "description": "Extra fields that are not part of the schema.", "default": {}, "type": "object" }, "protocols": { "title": "Protocols", "description": "\n Protocols regarding the manipulation of a Optimization output data.\n ", "default": {}, "allOf": [ { "$ref": "#/definitions/OptimizationProtocols" } ] }, "input_specification": { "title": "Input Specification", "description": "\n A compute description for energy, gradient, and Hessian computations used in a geometry optimization.\n ", "allOf": [ { "$ref": "#/definitions/QCInputSpecification" } ] }, "initial_molecule": { "title": "Initial Molecule", "description": "The starting molecule for the geometry optimization.", "allOf": [ { "$ref": "#/definitions/Molecule" } ] }, "provenance": { "title": "Provenance", "description": "Provenance information.", "default": { "creator": "QCElemental", "version": "0.28.0", "routine": "qcelemental.models.procedures" }, "allOf": [ { "$ref": "#/definitions/Provenance" } ] } }, "required": [ "input_specification", "initial_molecule" ], "additionalProperties": false, "definitions": { "TrajectoryProtocolEnum": { "title": "TrajectoryProtocolEnum", "description": "Which gradient evaluations to keep in an optimization trajectory.", "enum": [ "all", "initial_and_final", "final", "none" ], "type": "string" }, "OptimizationProtocols": { "title": "OptimizationProtocols", "description": "Protocols regarding the manipulation of a Optimization output data.", "type": "object", "properties": { "trajectory": { "description": "\n Which gradient evaluations to keep in an optimization trajectory.\n ", "default": "all", "allOf": [ { "$ref": "#/definitions/TrajectoryProtocolEnum" } ] } }, "additionalProperties": false }, "DriverEnum": { "title": "DriverEnum", "description": "Allowed computation driver values.", "enum": [ "energy", "gradient", "hessian", "properties" ], "type": "string" }, "HarmonicType": { "title": "HarmonicType", "description": "The angular momentum representation of a shell.", "enum": [ "spherical", "cartesian" ], "type": "string" }, "ElectronShell": { "title": "ElectronShell", "description": "Information for a single electronic shell.", "type": "object", "properties": { "angular_momentum": { "title": "Angular Momentum", "description": "Angular momentum for the shell as an array of integers.", "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0 }, "uniqueItems": true }, "harmonic_type": { "description": "The angular momentum representation of a shell.", "allOf": [ { "$ref": "#/definitions/HarmonicType" } ] }, "exponents": { "title": "Exponents", "description": "Exponents for the contracted shell.", "minItems": 1, "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "coefficients": { "title": "Coefficients", "description": "General contraction coefficients for the shell; individual list components will be the individual segment contraction coefficients.", "minItems": 1, "type": "array", "items": { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minItems": 1 } } }, "required": [ "angular_momentum", "harmonic_type", "exponents", "coefficients" ], "additionalProperties": false }, "ECPType": { "title": "ECPType", "description": "The type of the ECP potential.", "enum": [ "scalar", "spinorbit" ], "type": "string" }, "ECPPotential": { "title": "ECPPotential", "description": "Information for a single ECP potential.", "type": "object", "properties": { "ecp_type": { "description": "The type of the ECP potential.", "allOf": [ { "$ref": "#/definitions/ECPType" } ] }, "angular_momentum": { "title": "Angular Momentum", "description": "Angular momentum for the potential as an array of integers.", "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0 }, "uniqueItems": true }, "r_exponents": { "title": "R Exponents", "description": "Exponents of the 'r' term.", "minItems": 1, "type": "array", "items": { "type": "integer" } }, "gaussian_exponents": { "title": "Gaussian Exponents", "description": "Exponents of the 'gaussian' term.", "minItems": 1, "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "coefficients": { "title": "Coefficients", "description": "General contraction coefficients for the potential; individual list components will be the individual segment contraction coefficients.", "minItems": 1, "type": "array", "items": { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minItems": 1 } } }, "required": [ "ecp_type", "angular_momentum", "r_exponents", "gaussian_exponents", "coefficients" ], "additionalProperties": false }, "BasisCenter": { "title": "BasisCenter", "description": "Data for a single atom/center in a basis set.", "type": "object", "properties": { "electron_shells": { "title": "Electron Shells", "description": "Electronic shells for this center.", "minItems": 1, "type": "array", "items": { "$ref": "#/definitions/ElectronShell" }, "uniqueItems": true }, "ecp_electrons": { "title": "Ecp Electrons", "description": "Number of electrons replaced by ECP, MCP, or other field potentials.", "default": 0, "type": "integer" }, "ecp_potentials": { "title": "Ecp Potentials", "description": "ECPs, MCPs, or other field potentials for this center.", "minItems": 1, "type": "array", "items": { "$ref": "#/definitions/ECPPotential" }, "uniqueItems": true } }, "required": [ "electron_shells" ], "additionalProperties": false }, "BasisSet": { "title": "BasisSet", "description": "A quantum chemistry basis description.", "type": "object", "properties": { "schema_name": { "title": "Schema Name", "description": "The QCSchema specification to which this model conforms. Explicitly fixed as qcschema_basis.", "default": "qcschema_basis", "pattern": "^(qcschema_basis)$", "type": "string" }, "schema_version": { "title": "Schema Version", "description": "The version number of :attr:`~qcelemental.models.BasisSet.schema_name` to which this model conforms.", "default": 1, "type": "integer" }, "name": { "title": "Name", "description": "The standard basis name if available (e.g., 'cc-pVDZ').", "type": "string" }, "description": { "title": "Description", "description": "Brief description of the basis set.", "type": "string" }, "center_data": { "title": "Center Data", "description": "Shared basis data for all atoms/centers in the parent molecule", "type": "object", "additionalProperties": { "$ref": "#/definitions/BasisCenter" } }, "atom_map": { "title": "Atom Map", "description": "Mapping of all atoms/centers in the parent molecule to centers in ``center_data``.", "type": "array", "items": { "type": "string" } }, "nbf": { "title": "Nbf", "description": "The number of basis functions. Use for convenience or as checksum", "type": "integer" } }, "required": [ "name", "center_data", "atom_map" ], "additionalProperties": false, "$schema": "http://json-schema.org/draft-04/schema#" }, "Model": { "title": "Model", "description": "The computational molecular sciences model to run.", "type": "object", "properties": { "method": { "title": "Method", "description": "The quantum chemistry method to evaluate (e.g., B3LYP, PBE, ...). For MM, name of the force field.", "type": "string" }, "basis": { "title": "Basis", "description": "The quantum chemistry basis set to evaluate (e.g., 6-31g, cc-pVDZ, ...). Can be ``None`` for methods without basis sets. For molecular mechanics, name of the atom-typer.", "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/BasisSet" } ] } }, "required": [ "method" ] }, "QCInputSpecification": { "title": "QCInputSpecification", "description": "A compute description for energy, gradient, and Hessian computations used in a geometry optimization.", "type": "object", "properties": { "schema_name": { "title": "Schema Name", "default": "qcschema_input", "enum": [ "qcschema_input" ], "type": "string" }, "schema_version": { "title": "Schema Version", "default": 1, "type": "integer" }, "driver": { "description": "Allowed computation driver values.", "default": "gradient", "allOf": [ { "$ref": "#/definitions/DriverEnum" } ] }, "model": { "title": "Model", "description": "The computational molecular sciences model to run.", "allOf": [ { "$ref": "#/definitions/Model" } ] }, "keywords": { "title": "Keywords", "description": "The program specific keywords to be used.", "default": {}, "type": "object" }, "extras": { "title": "Extras", "description": "Additional information to bundle with the computation. Use for schema development and scratch space.", "default": {}, "type": "object" } }, "required": [ "model" ], "additionalProperties": false }, "Identifiers": { "title": "Identifiers", "description": "Canonical chemical identifiers", "type": "object", "properties": { "molecule_hash": { "title": "Molecule Hash", "type": "string" }, "molecular_formula": { "title": "Molecular Formula", "type": "string" }, "smiles": { "title": "Smiles", "type": "string" }, "inchi": { "title": "Inchi", "type": "string" }, "inchikey": { "title": "Inchikey", "type": "string" }, "canonical_explicit_hydrogen_smiles": { "title": "Canonical Explicit Hydrogen Smiles", "type": "string" }, "canonical_isomeric_explicit_hydrogen_mapped_smiles": { "title": "Canonical Isomeric Explicit Hydrogen Mapped Smiles", "type": "string" }, "canonical_isomeric_explicit_hydrogen_smiles": { "title": "Canonical Isomeric Explicit Hydrogen Smiles", "type": "string" }, "canonical_isomeric_smiles": { "title": "Canonical Isomeric Smiles", "type": "string" }, "canonical_smiles": { "title": "Canonical Smiles", "type": "string" }, "pubchem_cid": { "title": "Pubchem Cid", "description": "PubChem Compound ID", "type": "string" }, "pubchem_sid": { "title": "Pubchem Sid", "description": "PubChem Substance ID", "type": "string" }, "pubchem_conformerid": { "title": "Pubchem Conformerid", "description": "PubChem Conformer ID", "type": "string" } }, "additionalProperties": false }, "Provenance": { "title": "Provenance", "description": "Provenance information.", "type": "object", "properties": { "creator": { "title": "Creator", "description": "The name of the program, library, or person who created the object.", "type": "string" }, "version": { "title": "Version", "description": "The version of the creator, blank otherwise. This should be sortable by the very broad `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.", "default": "", "type": "string" }, "routine": { "title": "Routine", "description": "The name of the routine or function within the creator, blank otherwise.", "default": "", "type": "string" } }, "required": [ "creator" ], "$schema": "http://json-schema.org/draft-04/schema#" }, "Molecule": { "title": "Molecule", "description": "The physical Cartesian representation of the molecular system.\n\nA QCSchema representation of a Molecule. This model contains\ndata for symbols, geometry, connectivity, charges, fragmentation, etc while also supporting a wide array of I/O and manipulation capabilities.\n\nMolecule objects geometry, masses, and charges are truncated to 8, 6, and 4 decimal places respectively to assist with duplicate detection.\n\nNotes\n-----\nAll arrays are stored flat but must be reshapable into the dimensions in attribute ``shape``, with abbreviations as follows:\n\n * nat: number of atomic = calcinfo_natom\n * nfr: number of fragments\n * <varies>: irregular dimension not systematically reshapable", "type": "object", "properties": { "schema_name": { "title": "Schema Name", "description": "The QCSchema specification to which this model conforms. Explicitly fixed as qcschema_molecule.", "default": "qcschema_molecule", "pattern": "^(qcschema_molecule)$", "type": "string" }, "schema_version": { "title": "Schema Version", "description": "The version number of :attr:`~qcelemental.models.Molecule.schema_name` to which this model conforms.", "default": 2, "type": "integer" }, "validated": { "title": "Validated", "description": "A boolean indicator (for speed purposes) that the input Molecule data has been previously checked for schema (data layout and type) and physics (e.g., non-overlapping atoms, feasible multiplicity) compliance. This should be False in most cases. A ``True`` setting should only ever be set by the constructor for this class itself or other trusted sources such as a Fractal Server or previously serialized Molecules.", "default": false, "type": "boolean" }, "symbols": { "title": "Symbols", "description": "The ordered array of atomic elemental symbols in title case. This field's index sets atomic order for all other per-atom fields like :attr:`~qcelemental.models.Molecule.real` and the first dimension of :attr:`~qcelemental.models.Molecule.geometry`. Ghost/virtual atoms must have an entry here in :attr:`~qcelemental.models.Molecule.symbols`; ghostedness is indicated through the :attr:`~qcelemental.models.Molecule.real` field.", "shape": [ "nat" ], "type": "array", "items": { "type": "string" } }, "geometry": { "title": "Geometry", "description": "The ordered array for Cartesian XYZ atomic coordinates [a0]. Atom ordering is fixed; that is, a consumer who shuffles atoms must not reattach the input (pre-shuffling) molecule schema instance to any output (post-shuffling) per-atom results (e.g., gradient). Index of the first dimension matches the 0-indexed indices of all other per-atom settings like :attr:`~qcelemental.models.Molecule.symbols` and :attr:`~qcelemental.models.Molecule.real`.\nSerialized storage is always flat, (3*nat,), but QCSchema implementations will want to reshape it. QCElemental can also accept array-likes which can be mapped to (nat,3) such as a 1-D list of length 3*nat, or the serialized version of the array in (3*nat,) shape; all forms will be reshaped to (nat,3) for this attribute.", "shape": [ "nat", 3 ], "units": "a0", "type": "array", "items": { "type": "number" } }, "name": { "title": "Name", "description": "Common or human-readable name to assign to this molecule. This field can be arbitrary; see :attr:`~qcelemental.models.Molecule.identifiers` for well-defined labels.", "type": "string" }, "identifiers": { "title": "Identifiers", "description": "An optional dictionary of additional identifiers by which this molecule can be referenced, such as INCHI, canonical SMILES, etc. See the :class:`~qcelemental.models.results.Identifiers` model for more details.", "allOf": [ { "$ref": "#/definitions/Identifiers" } ] }, "comment": { "title": "Comment", "description": "Additional comments for this molecule. Intended for pure human/user consumption and clarity.", "type": "string" }, "molecular_charge": { "title": "Molecular Charge", "description": "The net electrostatic charge of the molecule.", "default": 0.0, "type": "number" }, "molecular_multiplicity": { "title": "Molecular Multiplicity", "description": "The total multiplicity of the molecule.", "default": 1, "type": "integer" }, "masses": { "title": "Masses", "description": "The ordered array of atomic masses. Index order matches the 0-indexed indices of all other per-atom fields like :attr:`~qcelemental.models.Molecule.symbols` and :attr:`~qcelemental.models.Molecule.real`. If this is not provided, the mass of each atom is inferred from its most common isotope. If this is provided, it must be the same length as :attr:`~qcelemental.models.Molecule.symbols` but can accept ``None`` entries for standard masses to infer from the same index in the :attr:`~qcelemental.models.Molecule.symbols` field.", "shape": [ "nat" ], "units": "u", "type": "array", "items": { "type": "number" } }, "real": { "title": "Real", "description": "The ordered array indicating if each atom is real (``True``) or ghost/virtual (``False``). Index matches the 0-indexed indices of all other per-atom settings like :attr:`~qcelemental.models.Molecule.symbols` and the first dimension of :attr:`~qcelemental.models.Molecule.geometry`. If this is not provided, all atoms are assumed to be real (``True``).If this is provided, the reality or ghostedness of every atom must be specified.", "shape": [ "nat" ], "type": "array", "items": { "type": "boolean" } }, "atom_labels": { "title": "Atom Labels", "description": "Additional per-atom labels as an array of strings. Typical use is in model conversions, such as Elemental <-> Molpro and not typically something which should be user assigned. See the :attr:`~qcelemental.models.Molecule.comment` field for general human-consumable text to affix to the molecule.", "shape": [ "nat" ], "type": "array", "items": { "type": "string" } }, "atomic_numbers": { "title": "Atomic Numbers", "description": "An optional ordered 1-D array-like object of atomic numbers of shape (nat,). Index matches the 0-indexed indices of all other per-atom settings like :attr:`~qcelemental.models.Molecule.symbols` and :attr:`~qcelemental.models.Molecule.real`. Values are inferred from the :attr:`~qcelemental.models.Molecule.symbols` list if not explicitly set. Ghostedness should be indicated through :attr:`~qcelemental.models.Molecule.real` field, not zeros here.", "shape": [ "nat" ], "type": "array", "items": { "type": "number", "multipleOf": 1.0 } }, "mass_numbers": { "title": "Mass Numbers", "description": "An optional ordered 1-D array-like object of atomic *mass* numbers of shape (nat). Index matches the 0-indexed indices of all other per-atom settings like :attr:`~qcelemental.models.Molecule.symbols` and :attr:`~qcelemental.models.Molecule.real`. Values are inferred from the most common isotopes of the :attr:`~qcelemental.models.Molecule.symbols` list if not explicitly set. If single isotope not (yet) known for an atom, -1 is placeholder.", "shape": [ "nat" ], "type": "array", "items": { "type": "number", "multipleOf": 1.0 } }, "connectivity": { "title": "Connectivity", "description": "A list of bonds within the molecule. Each entry is a tuple of ``(atom_index_A, atom_index_B, bond_order)`` where the ``atom_index`` matches the 0-indexed indices of all other per-atom settings like :attr:`~qcelemental.models.Molecule.symbols` and :attr:`~qcelemental.models.Molecule.real`. Bonds may be freely reordered and inverted.", "minItems": 1, "type": "array", "items": { "type": "array", "minItems": 3, "maxItems": 3, "items": [ { "type": "integer", "minimum": 0 }, { "type": "integer", "minimum": 0 }, { "type": "number", "minimum": 0, "maximum": 5 } ] } }, "fragments": { "title": "Fragments", "description": "List of indices grouping atoms (0-indexed) into molecular fragments within the molecule. Each entry in the outer list is a new fragment; index matches the ordering in :attr:`~qcelemental.models.Molecule.fragment_charges` and :attr:`~qcelemental.models.Molecule.fragment_multiplicities`. Inner lists are 0-indexed atoms which compose the fragment; every atom must be in exactly one inner list. Noncontiguous fragments are allowed, though no QM program is known to support them. Fragment ordering is fixed; that is, a consumer who shuffles fragments must not reattach the input (pre-shuffling) molecule schema instance to any output (post-shuffling) per-fragment results (e.g., n-body energy arrays).", "shape": [ "nfr", "<varies>" ], "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 1.0 } } }, "fragment_charges": { "title": "Fragment Charges", "description": "The total charge of each fragment in the :attr:`~qcelemental.models.Molecule.fragments` list. The index of this list matches the 0-index indices of :attr:`~qcelemental.models.Molecule.fragments` list. Will be filled in based on a set of rules if not provided (and :attr:`~qcelemental.models.Molecule.fragments` are specified).", "shape": [ "nfr" ], "type": "array", "items": { "type": "number" } }, "fragment_multiplicities": { "title": "Fragment Multiplicities", "description": "The multiplicity of each fragment in the :attr:`~qcelemental.models.Molecule.fragments` list. The index of this list matches the 0-index indices of :attr:`~qcelemental.models.Molecule.fragments` list. Will be filled in based on a set of rules if not provided (and :attr:`~qcelemental.models.Molecule.fragments` are specified).", "shape": [ "nfr" ], "type": "array", "items": { "type": "integer" } }, "fix_com": { "title": "Fix Com", "description": "Whether translation of geometry is allowed (fix F) or disallowed (fix T).When False, QCElemental will pre-process the Molecule object to translate the center of mass to (0,0,0) in Euclidean coordinate space, resulting in a different :attr:`~qcelemental.models.Molecule.geometry` than the one provided. 'Fix' is used in the sense of 'specify': that is, `fix_com=True` signals that the origin in `geometry` is a deliberate part of the Molecule spec, whereas `fix_com=False` (default) allows that the origin is happenstance and may be adjusted. guidance: A consumer who translates the geometry must not reattach the input (pre-translation) molecule schema instance to any output (post-translation) origin-sensitive results (e.g., an ordinary energy when EFP present).", "default": false, "type": "boolean" }, "fix_orientation": { "title": "Fix Orientation", "description": "Whether rotation of geometry is allowed (fix F) or disallowed (fix T). When False, QCElemental will pre-process the Molecule object to orient via the intertial tensor, resulting in a different :attr:`~qcelemental.models.Molecule.geometry` than the one provided. 'Fix' is used in the sense of 'specify': that is, `fix_orientation=True` signals that the frame orientation in `geometry` is a deliberate part of the Molecule spec, whereas `fix_orientation=False` (default) allows that the frame is happenstance and may be adjusted. guidance: A consumer who rotates the geometry must not reattach the input (pre-rotation) molecule schema instance to any output (post-rotation) frame-sensitive results (e.g., molecular vibrations).", "default": false, "type": "boolean" }, "fix_symmetry": { "title": "Fix Symmetry", "description": "Maximal point group symmetry which :attr:`~qcelemental.models.Molecule.geometry` should be treated. Lowercase.", "type": "string" }, "provenance": { "title": "Provenance", "description": "The provenance information about how this Molecule (and its attributes) were generated, provided, and manipulated.", "allOf": [ { "$ref": "#/definitions/Provenance" } ] }, "id": { "title": "Id", "description": "A unique identifier for this Molecule object. This field exists primarily for Databases (e.g. Fractal's Server) to track and lookup this specific object and should virtually never need to be manually set." }, "extras": { "title": "Extras", "description": "Additional information to bundle with the molecule. Use for schema development and scratch space.", "type": "object" } }, "required": [ "symbols", "geometry" ], "additionalProperties": false, "$schema": "http://json-schema.org/draft-04/schema#" } } }
- Fields:
-
field input_specification:
QCInputSpecification[Required] A compute description for energy, gradient, and Hessian computations used in a geometry optimization.
-
field protocols:
OptimizationProtocols= OptimizationProtocols(trajectory=<TrajectoryProtocolEnum.all: 'all'>) Protocols regarding the manipulation of a Optimization output data.
-
field provenance:
Provenance= Provenance(creator='QCElemental', version='0.28.0', routine='qcelemental.models.procedures') Provenance information.
-
field schema_name:
ConstrainedStrValue= 'qcschema_optimization_input' - Constraints:
pattern = qcschema_optimization_input