Changelog

0.50.0rc3 / 2026-03-10

Docs v0.50.0rc3 for current. Docs v0.30.2 for QCSchema v1.

New Features

  • (GH#391) Add convert_v support to AtomicProperties and AtomicProtocols.

  • (GH#392) Extend qcelemental.models.v2.optimization to accept ManyBody specifications/results/properties (when qcmanybody is available). Replaces GeneralizedOptimizationInput etc. that worked for QCManyBody and optking for v1 counterpoise-corrected optimizations.

Enhancements

  • (GH#391) Make Molecule and WavefunctionProperties tolerant of None being passed in during construction (important for relying more in future on pydantic rather than custom serialization).

  • (GH#392) Update model survey tests to include ManyBody v2 classes and Provenance and to test extra fields mostly forbidden.

Bug Fixes

  • (GH#392) More precise Pydantic version constraints: v2.11, unless py314+

Misc.

  • (GH#391) Remove unused config options (canonical_repr and repr_style) and serialize_default_excludes functionality.

0.50.0rc2 / 2026-02-17

Docs v0.50.0rc2 for current. Docs v0.30.2 for QCSchema v1.

Breaking Changes (low impact)

  • (GH#382, GH#383) Remove CPU (ProcessorInfo and ProcessorContext) and DFT info (DFTFunctionalInfo and DFTFunctionalContext) classes and functionality

  • (GH#389) Remove the QCElemental pydantic autodoc module (util.autodocs module, classes AutoPydanticDocGenerator and AutodocBaseSettings)

Enhancements

  • (GH#390) Removed the “Imports will provide non-functional placeholders” FutureWarning for <py314

  • (GH#390) Added qcelemental.models.QCEL_V1V2_SHIM_CODE as magic var to signal returning _v1v2 model.

  • (GH#390)) Removed sphinx-autodoc-typehints

  • (GH#388) Molecule: Fix imports, typing, @property logic (exp. connectivity, printing of float multiplicity, and returning type(self) to handle derived classes

  • (GH#385) Start building docs for QCSchema v2 models. If downstream docs builds are complaining about dtype here, add os.environ[“SPHINX_BUILD”] = “1” to Sphinx conf.py Note that this changes intersphinx links. Below is current (for next2026).

"qcelemental": ("https://molssi.github.io/QCElemental/next/", None),
"qcengine": ("https://molssi.github.io/QCEngine/next/", None),
"qcfractal": ("https://docs.qcarchive.molssi.org/", None),

0.50.0rc1 / 2026-01-13 (aka “next” aka “QCSchema v2 available”) (Prerelease)

Breaking Changes

  • (GH#377) Note that Pydantic doesn’t offer its v1 API within version v2 for Python >=3.14. For 314, while all imports will work, attempting to instantiate a QCSchema v1 model will raise a RuntimeError.

Breaking Changes (long expired)

  • (GH#346) The very old model names ResultInput, Result, ResultProperties, Optimization deprecated in 2019 are now only available through qcelelemental.models.v1

  • (GH#347) models.v2 do not support AutoDoc. The AutoDoc routines have been left at pydantic v1 syntax. Use autodoc-pydantic for Sphinx instead.

New Features

  • (GH#361) Switch from poetry to setuptools build backend.

  • (GH#346) Downstream code should from qcelemental.models.v1 import Molecule, AtomicResult etc. to assure medium-term availability of existing models.

  • (GH#347) Introduces QCSchema v2 models written in Pydantic v2 API. New models available as from qcelemental.models.v2 import Molecule, AtomicResult etc.

  • There is a graphical [cheat sheet](docs/qcschema_cheatsheet_9Jan2026.pdf) comparing QCSchema v1 and v2. There is also a [migration guide](docs/MIGRATION.md)

  • (GH#352) AtomicInput and AtomicResult OptimizationInput, OptimizationResult, TorsionDriveInput, TorsionDriveResult, FailedOperation (both versions) learned a .convert_v(ver) function that returns self or the other version.

  • (GH#354) Unlike Levi’s pyd v2, this doesn’t forward define dict, copy, json to v2 models. Instead it backwards-defines model_dump, model_dump_json, model_copy to v1. This will impede upgrading but be cleaner in the long run. See commented-out functions to temporarily restore this functionality. v2.Molecule retains its dict for now

Enhancements

Build, Maintenance, & Versions

  • (GH#361) Move from poetry to setuptools build backend and versioneer to scm-version for versioning.

  • Pydantic 2 now required. v2.12 for Python 3.14.

  • (GH#377) Now all python versions can import everything (even if no good b/c Pydantic v1 API not available for Python 3.14). There’s FutureWarnings thrown (no more DeprecationWarnings) on any import. Python 3.14 will fail to instantiate the forbidden models and raise a RuntimeError, but otherwise all Pythons are operational.

  • (GH#345) Set up precommit.

  • (GH#359) isort version bumped to 5.13 and imports and syntax take advantage of python 3.8+

Imports, module layout

  • (GH#345) Move models to models.v1 to preserve the longstanding QCSchema v1.

  • (GH#349) Dummy files added to models/ directory to mirror v1 layout (e.g., models/results.py). These reroute imports to v1/ so downstream can run w/o alteration with from qcelemental.models.procedures import OptimizationInput, etc. Warnings are added to the dummy files to promote loading from models, models.v1, or models.v2, not models.v1.results etc.

  • (GH#349, GH#366) Many more of the lesser-used models are importable from qcel.models (or its v1 and v2 subdirectories). This includes TorsionDriveInput, TorsionDriveResult, Model, AtomicResultProtocols, QCInputSpecification, OptimizationSpecification, and TDKeywords (PR 349). Also, ElectronShell, BasisCenter, ECPPotential importable from top level models (PR 366). This is part of a recommended change to always import directly from models, models.v1, etc.

  • (GH#366) For models.v2, procedures.py was separated (into opt and td) and results.py was renamed, so models are separated into atomic.py, optimization.py, and torsion_drive.py. Failure models were moved to failed_operation.py. Also, basis.py was renamed to basis_set.py .

  • (GH#377) Not part of API. If you must have QCSchema v1 in Pydantic v2 API (for Python 3.14), ask @loriab about the _v1v2 transition class. Never return objects of these classes.

Slight alterations to v1 QCSchema

  • models.v1 models AtomicInput, AtomicResult, OptimizationInput, OptimizationResult, TorsionDriveInput, TorsionDriveResult, Molecule, BasisSet, QCInputSpecification, OptimizationSpecification, OptimizationProtocols, WavefunctionProperties learned a .convert_v(target_version) to return either itself (with target_version=1) or convert to QCSchema v2 (with target_version=2). This is recommended to use over hand-mapping.

  • (GH#352, GH#357) The models.v1 AtomicInput, AtomicResult, OptimizationInput, OptimizationResult, TorsionDriveInput, TorsionDriveResult (PR 352) and BasisSet, QCInputSpecification, OptimizationSpecification (PR 357) had their schema_version changed from an int to a Literal[1]. “Result”s given schema_version in their own right rather than inheriting from Input. (Intermediate PRs in next branch added validation to schema_version so new instances stamped as 1, even if another value passed in. By the time of next merge, all such translation is handled in convert_v, so incorrent values will fail instantiation.)

  • (GH#357) v1.Molecule had its schema_version changed to a Literal[2] (remember Mol is one-ahead of general numbering scheme) so new instances will be 2 even if another value is passed in.

  • (GH#354, GH#357) Molecule.extras (PR 354) and FailedOperation.extras (PR 357) default changed from None to {} rather in both v1 and v2. Input None converts to {} upon instantiation.

  • (GH#352) v1.ProtoModel learned model_copy, model_dump, model_dump_json methods (all w/o warnings) so downstream can unify on newer Pydantic v2 syntax. (Levi’s work alternately/additionally taught v2 copy, dict, json (all w/warning) but dict has an alternate use in Pydantic v2.)

  • (GH#358) v1.AtomicResult.convert_v learned a external_input_data option to inject that field (if known) rather than using incomplete reconstruction from the v1 Result. may not be the final sol’n.

New v2 Schema: generic changes wrt v1

  • models.v2 models AtomicInput, AtomicResult, OptimizationInput, OptimizationResult, TorsionDriveInput, TorsionDriveResult, Molecule, BasisSet, AtomicSpecification, OptimizationSpecification, OptimizationProtocols, WavefunctionProperties learned a .convert_v(target_version) to return either itself (with target_version=2) or convert to QCSchema v1 (with target_version=1). This is recommended to use over hand-mapping.

  • (GH#363) All the v2 models (Protocols/Keywords/Specification/Input/Properties/Result) get Literal schema_name starting with “qcschema” (many v1 models didn’t have a name; some v1 models allowed “qc_schema_”).

  • (GH#347) The models.v2 have had their schema_version bumped for BasisSet, AtomicInput, OptimizationInput (implicit for AtomicResult and OptimizationResult), TorsionDriveInput , and TorsionDriveResult.

  • (GH#347, GH#352) The models.v2 BasisSet, AtomicInput, AtomicResult, AtomicResultProperties OptimizationInput, OptimizationResult, TorsionDriveInput, TorsionDriveResult had their schema_version bumped (PR 347) and changed to a Literal[2] (PR 352).

  • (GH#366) v2: standardizing on Input/Result get schema_version, Protocols/Keywords/Specification get only schema_name. (v1 models gave schema_version to Input/Specification and Result inherited from Input.)

  • (GH#357, GH#536) v2.AtomicResult, v2.OptimizationResult, and v2.TorsionDriveResult have the success field enforced to True. Previously it could be set T/F. Now validation errors if not T. Likewise v2.FailedOperation.success is enforced to False.

  • (GH#357, GH#536) v2.AtomicResult, v2.OptimizationResult, and v2.TorsionDriveResult have the error field removed. This isn’t used now that success=True and failure should be routed to FailedOperation.

  • Of the top-level fields normally in a Input schema in v1, only molecule remains in v2; others are moved to a Specification schema. For example, OptimizationInput.specification = OptimizationSpecification. This helps schema be more composible and reuseable.

  • Result schema classes no longer inherit from Input as in v1. Now input is stored as a field in result, e.g., OptimizationResult.input_data = OptimizationInput. This helps preserve info for restart and prevent overwriting Molecule and Provenance.

New v2 Schema: Molecule, BasisSet, FailedOperation changes wrt v1

  • (GH#366) v2.Molecule.schema_version is now 3, with no layout change.

  • (GH#366) molparse learns to pass through schema v3, though no new field for Mol yet.

  • (GH#366) v2.BasisSet.schema_version is now 2, with no layout change. BasisSet.schema_name standardized to qcschema_basis_set.

  • (GH#366) Molecule and BasisSet and WavefunctionProperties learned to convert_v to interconvert between v1 and v2. No layout changes.

  • (GH#358, GH#366) v2.FailedOperation gained schema_name and schema_version=2. unversioned in v1

  • (GH#352) v2.FailedOperation field id is becoming Optional[str] instead of plain str so that the default validates.

New v2 Schema: Atomic changes wrt v1

  • (GH#366) AtomicResultProtocols renamed to AtomicProtocols and AtomicResultProperties to AtomicProperties

  • (GH#359) v2.AtomicInput gained a specification field where driver, model, keywords, extras, and protocols now live. v2.AtomicSpecification and v1.QCInputSpecification (used by opt and td) learned a convert_v to interconvert.

  • (GH#359) v2.AtomicSpecification, unlike v1.QCInputSpecification, doesn’t have schema_name and schema version.

  • (GH#363) Whereas v1.AtomicInput and v1.QCInputSpecification shared the same schema_name, v2.AtomicInput and v2.AtomicSpecification do not. This is a step towards more explicit schema names.

  • (GH#359) v2.AtomicInput lost extras so extras belong unambiguously to the AtomicSpecification.

  • (GH#358) v2.AtomicResult no longer inherits from v2.AtomicInput. It gained a input_data field for the corresponding AtomicInput and independent id and molecule fields (the latter being equivalvent to v1.AtomicResult.molecule with the frame of the results; v2.AtomicResult.input_data.molecule is new, preserving the input frame). AtomicResult gained an independent extras.

  • (GH#363, GH#366) v2.AtomicResult.schema_name becomes a Literal, no longer accepts “qc_schema*”, and changes from qcschema_output to qcschema_atomic_result.

  • (GH#363) qcschema_input and qcschema_output now are qcschema_atomic_input and qcschema_atomic_output

  • (GH#363) v2.AtomicResult.convert_v() learned external_protocols option to inject that field if known from OptIn

New v2 Schema: Optimization changes wrt v1

  • (GH#366) v2.OptimizationProtocol renamed trajectory_results from trajectory in accordance with the protocol naming the controlled field. No default change yet.

  • (GH#366) Default of OptimizationProtocol.trajectory_results changed to “none” from “all” in v1. Much info can now come from trajectory_properties.

  • (GH#363) v2.OptimizationInput got a Literal schema_name now. Field specification now takes an OptimizationSpecification that itself takes an AtomicSpecification. This replaces from v1 field input_specification that took a QCInputSpecification. v2.OptimizationInput gained a protocols field. Fields keywords, extras, and protocols from Input are now in OptimizationSpecification.

  • (GH#363) v2.OptimizationSpecification now is used every optimization as v2.OptimizationInput.specification = OptimizationSpecification rather than only in torsion drives. No longer has schema_name and schema_version. Its. procedures field is now program. Gains new field specification that is most commonly AtomicSpecification but could be ManyBodySpecification or any other E/G/H producer.

  • (GH#357) v2.OptimizationSpecification lost its schema_version (compared to v1) but gained an extras field.

  • (GH#366) v2.OptimizationResult.schema_name changed from qcschema_optimization_output to qcschema_optimization_result.

  • (GH#352) The models.v1 and models.v2 OptimizationResult given schema_version for the first time.

  • (GH#363) v2.OptimizationResult gained a input_data field for the corresponding OptimizationInput and independent id and extras. No longer inherits from OptimizationInput. Literal schema_name.

  • (GH#363) v2.OptimizationResult gained a native_files field, though not protocols for user control.

  • (GH#363) v2.OptimizatonResult.energies becomes v2.OptimizationResult.trajectory_properties and ManyBody allowed as well as atomic. Much expands information returned.

  • (GH#363) v2.OptimizatonResult.trajectory becomes v2.OptimizationResult.trajectory_results and ManyBody allowed as well as atomic.

  • (GH#363) Added a new basic v2.OptimizationProperties for expansion later. for now has number of opt iter. Lodged in OptimizationResult.properties.

New v2 Schema: TorsionDrive changes wrt v1

  • (GH#363, GH#366) v2.TDKeywords got a schema_name field and was renamed to TorsionDriveKeywords

  • (GH#366) New v2.TorsionDriveProtocols model with field scan_results to control all/none/lowest saving of OptimizationResult s at each grid point. Use “all” for proper conversion to v1.

  • (GH#363) v2. TorsionDriveSpecification is a new model. instead of v2.TorsionDriveInput having a input_specification and an optimization_spec fields, it has a specification field that is a TorsionDriveSpecification which in turn hold opt info and in turn gradient/atomic info.

  • (GH#363) v2.TorsionDriveResult no longer inherits from Input and now has indep id and extras and new native_files.

  • (GH#367) v1.TorsionDriveResult.final_energies replaced by larger v2.TorsionDriveResult.scan_properties. The former is present in the latter as return_energy.

  • (GH#366) main storage for v2.TorsionDriveResult moved from optimization_history to scan_results.

  • (GH#363) v2.TorsionDriveResult gained a native_files field, though not protocols for user control.

  • (GH#367) v2.TorsionDriveProperties added mostly as a placeholder class (one obvious prop at present).

Misc.

  • (GH#354) Fix a lot of warnings originating in this project.

  • (GH#348) All of Datum, DFTFunctional, and CPUInfo models, none of which are mixed with QCSchema models, are translated to Pydantic v2 API syntax.

  • (GH#377) no longer testing/ensuring np.array([single-float]) are coerced into float property results

0.30.0 / 2026-01-07

Enhancements

  • (GH#368, GH#379) Remove uneeded printing and hook up verbosity control for charge/multiplicity reconciliation for Molecule.from_data. @jaclark5

Bug Fixes

  • (GH#371) Add setuptools as general dependency just in case nglview is present, so pkg_resources can be imported. After next nglview release, this can be removed. nglview v4.0 released early October but still very new so setuptools stays.

  • (GH#372) Fix some PubChem lookups that stopped working.

  • (GH#376) Fix verbosity of models/molecule.py log messages

Misc.

  • (GH#371) Extend poetry constraints to allow Python 3.13.

  • (GH#378) Extend poetry constraints to forbid Python 3.14 due to pydantic.v1 not available for QCSchema.

0.29.0 / 2025-01-13

Breaking Changes

  • (GH#341) packaging is now a required dependency.

New Features

  • (GH#350, GH#318, GH#317) Make behavior consistent between molecular_charge/ fragment_charges and molecular_multiplicity/fragment_multiplicities by allowing floating point numbers for multiplicities. Non-fractional multiplicities are coerced to integers for minimal disruption. @awvwgk

  • (GH#360) Molecule learned new functions element_composition and molecular_weight. The first gives a dictionary of element symbols and counts, while the second gives the weight in amu. Both can access the whole molecule or per-fragment like the existing nelectrons and nuclear_repulsion_energy. All four can now select all atoms or exclude ghosts (default).

Enhancements

  • (GH#340, GH#330) Add molecular charge and multiplicity to Molecule repr formula, so neutral singlet unchanged but radical cation has ‘2^formula+’. @awvwgk

  • (GH#341) Use packaging instead of deprecated setuptools to provide version parsing for qcelemental.util.parse_version and qcelemental.util.safe_version. This behaves slightly different; “v7.0.0+N/A” was processed ok before but fails with newer version. @berquist

  • (GH#353) Copied in pkg_resources.safe_version code as follow-up to GH#341, Eric’s switch to packaging. Both NWChem and Gamess are now working again.

  • (GH#343) Molecular and fragment multiplicities are now always enforced to be >=1.0. Previously this wasn’t checked for Molecule(…, validate=False). Error messages will change sometimes change for validate=True (run by default).

  • (GH#343) qcelemental.molparse newly allows floats that are ints (e.g., 1.0) for multiplicity. Previously it would raise an error about not being an int.

  • (GH#337) Solidify the (unchanged) schema_name for QCInputSpecification and AtomicResult into Literals where previously they had been regex strings coerced into a single name. The literals allow pydantic to discriminate models, which benefits GeneralizedOptimizationInput/Result in QCManyBody/QCEngine/OptKing. The only way this can interfere is if schema producers have whitespace around schema_name for these models or if any AtomicResult s are still using “qc_schema_output”, which looks to have only been added for compatibility with pre-pydantic QCSchema.

Bug Fixes

  • (GH#342, GH#333) Update some docs settings and requirements for newer tools. Should fix graphviz class diagram in docs.

Misc.

  • (GH#344, GH#282) Add a citation file since QCElemental doesn’t have a paper. @lilyminium

0.28.0 / 2024-06-21

Enhancements

  • (GH#338) Adapts for numpy v2 (only works with pint >= v0.24). v1 still compatible.

  • (GH#335, GH#334) Numpy >=1.26 only works with pint >=0.21. @TyBalduf

0.27.1 / 2023-10-26

Bug Fixes

  • (GH#329) Continues GH#328 adding util.which workaround for only python v3.12.0 and psi4 (can be expanded) to correctly select among cmd, cmd.bat, cmd.exe.

0.27.0 / 2023-10-24

Breaking Changes

New Features

  • (GH#326, GH#327) New protocol option occupations_and_eigenvalues added to WavefunctionProperties to store lightweight fields.

Enhancements

  • (GH#322) Allow util.which to raise a clearer error when handling pyenv shims. Improve docs.

Bug Fixes

  • (GH#325, GH#324) Ensure util.measure_coordinates isn’t returning NaN angles just

    because floating-point errors are outside arccos’s [-1, 1] bounds.

  • (GH#315) Stop resetting numpy print formatting.

  • (GH#328) Add workaround for only python v3.12.0 and psi4 (can be expanded) to handle util.which on Windows when a cmd (non-executable) and a cmd.<executable_extension> live side-by-side. Otherwise see [WinError 193] %1 is not a valid Win32 application.

Misc.

  • (GH#320) Reset black formatting to 2022.

  • (GH#327) Enable Python v3.12 in poetry.

  • (GH#328) Start Windows testing and cron testing.

0.26.0 / 2023-07-31

Breaking Changes

  • (GH#308) Fix CI Pipelines. Dropped Python3.6. Bring CI pipelines into harmony with local dev experience. Lint and format entire code base. Accelerate CI pipelines. Update setup.py to correctly define extras packages. Breaking change due to dropped support for Python3.6. No code functionality was altered.

    • Dropped support for dead Python 3.6. Minimum supported Python is now 3.7.

    • Updated CONTRIBUTING.md to contain detailed instructions for developers on how to contribute.

    • Fixed broken code that failed to prepend the “v” to version numbers.

    • Updated CI to run without conda and using only packages defined in setup.py. CI is now much faster and runs the same way for local developers and GitHub Actions.

    • Added test.sh and format.sh to devtools/scripts for easy execution of formatting and testing.

    • Formatted all code with black. Sorted imports with isort.

    • Added pre-commit to repo so code formatting, linting, and testing will all run as part of regular git workflow.

Enhancements

  • (GH#310) Modernize DevOps Tooling

    • Added /scripts directory to root of project that contains scripts for testing, formatting code, and building docs.

    • Updated build system from setuptools to modern pyproject.toml specification using poetry for the build backend.

    • Removed complicated versioning code in favor of single source of truth in pyproject.toml. Using standard library importlib for looking up package version in __init__.py file.

    • Added build_docs.sh script to /scrips and removed Makefile from /docs. Flattened /docs file structure.

    • Removed travis-ci code from devtools

    • Removed LGTM code (they no longer exist as a project).

    • Bring all package directories under black, isort, and autoflake control.

Bug Fixes

  • (GH#305) Initialize Molecule.extras as empty dictionary.

  • (GH#311) Update docs location from RTD to GH pages. Resolve escape char warnings. Update changelog.

  • (GH#311) Clear up NumPy “Conversion of an array with ndim > 0 to a scalar is deprecated” in util.measure_coordinates called by Molecule.measure.

  • (GH#314) Import pydantic.v1 from pydantic v2 so that QCElemental can work with any >=1.8.2 pydantic until QCElemental is updated for v2.

0.25.1 / 2022-10-31

Bug Fixes

  • (GH#297) Rearrange imports for compatibility with Pint v0.20. No new restrictions on pint version.

0.25.0 / 2022-06-13

Breaking Changes

New Features

Enhancements

  • (GH#285) Standardized default on AtomicResult.native_files to {} from None. May break strict logic.

  • (GH#289, GH#290) Transition from some early documentation tools (class AutodocBaseSettings and qcarchive_sphinx_theme) to externally maintained ones (project https://github.com/mansenfranzen/autodoc_pydantic and sphinx_rtd_theme). Expand API docs.

Bug Fixes

  • (GH#286) Sphinx autodocumentation with typing of qcelemental.testing.compare_recursive no longer warns about circular import.

0.24.0 / 2021-11-18

New Features

  • (GH#275) AtomicResult gains a native_files field of a dictionary of file names (or generic 'input') and text (not binary) contents that the CMS program may have generated but which haven’t necessarily been harvested into QCSchema. Contents controlled by a new native_files protocol analogous to stdout protocol.

Enhancements

  • (GH#281) TorsionDriveInput now accepts a list of Molecule objects as the initial_molecule to seed the torsiondrive with multiple conformations.

0.23.0 / 2021-09-23

Breaking Changes

  • (GH#276) AtomicResultProperties.dict() no longer forces arrays to JSON flat lists but now allows NumPy arrays. That is, AtomicResultProperties now behaves like every other QCElemental model. Expected to be disruptive to QCFractal.

  • (GH#280) Examples of QCSchema from test cases are now saved at branch https://github.com/MolSSI/QCElemental/tree/qcschema-examples . These have passed validation as models by Pydantic and as JSON by schema generated from Pydantic models.

New Features

Enhancements

  • (GH#274) The molecule from_string parser when no dtype specified learned to return the most specialized error message among the dtypes, not the full input string.

  • (GH#276) Molecule.to_string(..., dtype="nwchem") learned to handle ghosts (real=False) correctly. It also now prints the user label, which is used downstream for custom basis sets and shows up in a NWChem output file. QCEngine will be edited to process the label, but other uses may need modification.

  • (GH#276) Molecule.align learned a new keyword generic_ghosts=True so that it can act on molecules that have centers with content Gh, not Gh(He).

Bug Fixes

  • (GH#276) Molecule.to_string(..., dtype="gamess") learned to handle ghosts (real=False) correctly for coord=unique. Note that QCEngine uses coord=prinaxis, so actual ghosts are still NOT interpretable by downstream GAMESS.

0.22.0 / 2021-08-26

New Features

  • (GH#268) Add provisional models that store the inputs to and outputs of a torsion drive procedure. @SimonBoothroyd

  • (GH#272) Add SCF and return gradient and Hessian fields to AtomicResultProperties.

Enhancements

  • (GH#271) Molecule learned to create instances with geometry rounded to other than 8 decimal places through Molecule(..., geometry_noise=<13>) to optionally override qcel.models.molecule.GEOMETRY_NOISE = 8. This should be used sparingly, as it will make more molecules unique in the QCA database. But it is sometimes necessary for accurate finite difference steps and to preserve intrinsic symmetry upon geometry rotation. Previous route was to reset the qcel module variable for the duration of instance creation.

  • (GH#271) Molecule.align and Molecule.scramble learned to return a fuller copy of self than previously. Now has aligned atom_labels, real, and mass_numbers as well as incidentals like Identifiers. Fragmentation still not addressed.

  • (GH#271) Molecule.to_string(dtype="gamess") learned to write symmetry information to the prinaxis output if passed in through field fix_symmetry. This is provisional, as we’d like the field to be uniform across qcprogs.

Bug Fixes

  • (GH#271) Testing function compare_values() on arrays corrected the RMS maximum o-e value displayed and added a relative value.

0.21.0 / 2021-06-30

New Features

  • (GH#267) Serialization learned msgpack mode that, in contrast to msgpack-ext, doesn’t embed NumPy objects.

Enhancements

  • (GH#266) Testing function compare_values() learned to print RMS and MAX statistics for arrays.

Bug Fixes

0.20.0 / 2021-05-16

New Features

  • (GH#257) PhysicalConstantsContext learned to write a Fortran header. @awvwgk

Enhancements

  • (GH#261) Documentation became type-aware and grew more links.

0.19.0 / 2021-03-04

New Features

Enhancements

Bug Fixes

  • (GH#253) Fixed incompatibility with Pydantic >=1.8.

0.18.0 / 2021-02-16

New Features

  • (GH#237) Exports models to JSON Schema with make schema.

  • (GH#237) Build bank of JSON examples from Pydantic models defined in tests. Test that bank against exported schema with pytest --validate qcelemental/.

  • (GH#237) Many model descriptions edited, dimensions added to array properties, AtomicInput.model.basis now takes BasisSet object not just string, several properties added to match QCSchema, several limitations on number and uniqueness imposed.

Enhancements

  • (GH#237) Improve mypy conformance including dynamic provenance. Necessitates Pydantic >=1.5.

  • (GH#237) a0 without underscore added as computable pint unit.

  • (GH#246, GH#250) Removes types deprecated in NumPy v1.20.0.

Bug Fixes

  • (GH#244) Fixes where in code validation throws if center_data missing from BasisSet model.

  • (GH#249) Fixes web tests that weren’t marked.

0.17.0 / 2020-10-01

Enhancements

  • (GH#238) molparse.to_string MRChem dtype developed.

0.16.0 / 2020-08-19

New Features

Enhancements

  • (GH#231) compare, compare_values, and compare_recursive learned new keyword equal_phase that when True allows either computed or -computed to pass the comparison. For compare_recursive, the leniency can be restricted to specific leaves of the iterable by passing a list of allowed leaves.

Bug Fixes

  • (GH#229) Molecule.align told the full truth in its documentation that the mol_align argument can take a float.

0.15.1 / 2020-06-25

Bug Fixes

  • (GH#228) Fix testing bug for installed module, which was missing a dummy directory.

0.15.0 / 2020-06-25

New Features

  • (GH#182) Added experimental protocol for controlling autocorrection attemps. (That is, when a calculation throws a known error that QCEngine thinks it can tweak the input and rerun.) Currently in trial for NWChem.

Enhancements

  • (GH#186, GH#223) molparse.to_string Orca and MADNESS dtypes developed.

  • (GH#226) Allow which_import to distinguish between ordinary and namespace packages.

  • (GH#227) Add non-default strict argument to periodictable.to_Z, to_symbol, and to_element that fails when isotope information is given.

  • (GH#227) Allow nonphysical masses to pass validation in molparse.from_schema(..., nonphysical=True). Also allowed in forming qcel.models.Molecule(..., nonphysical=True).

Bug Fixes

  • (GH#227) Fixed deception described in issue 225 where qcel.models.Molecule(..., symbols=["O18"]) accepted “O18” but did not influence the isotope, as user might have expected. That now raises NotAnElementError, and an example of correctly setting isotope/masses has been added. This error now caught at qcel.molparse.from_arrays so general.

0.14.0 / 2020-03-06

New Features

Enhancements

  • (GH#211) Improve testing reliability by excusing PubChem when internet flaky.

  • (GH#216) “CODATA2018” constants now tested.

  • (GH#207) Multipoles exist in AtomicResultProperties as ndarray with order-dimensional shape. Property scf_quadrupole_moment defined.

Bug Fixes

  • (GH#216) Fixes a bug where “CODATA2018” constants could not be used with conversion_factor.

  • (GH#217) Can now run .schema() on pydantic classes containing Array fields (allowing ndarray in place of List).

0.13.1 / 2020-02-05

New Features

  • (GH#209) Added the option to Hill-order molecular formulas.

Bug Fixes

  • (GH#208) Fixes a Molecule hashing issue due to order of operations changes in Molecule.from_data. The order of operations changed in Molecule.from_data and occasionally resulted in different hashes for Molecules undergoing orient operations. This issue was introduced in 0.13.0 and is unlikely to have any serious negative effects as this did not affect hash integrity.

0.13.0 / 2020-01-29

New Features

  • (GH#183, GH#187) Added metadata about DFT functionals (qcelemental.info.dftfunctionalinfo).

  • (GH#184) Optional PubChem identifiers were added to molecules.

  • (GH#187, GH#192, GH#195) Added metadata about CPUs (qcelemental.info.cpu_info).

Enhancements

  • (GH#179, GH#181) QCElemental works with Python 3.8 at the expense of needing a new 0.10 pint (rather than generic install). Pint 0.10 has optional NumPy dependency of >=1.12.0, so QCElemental that requires both NumPy and pint needs this constraint.

  • (GH#172, GH#173, GH#202, GH#203) Contribution improvements, including GitHub Actions checking, make format guidance, and updated CONTRIBUTING.md.

  • (GH#189, GH#196) Constants and unit conversion based on 2018 CODATA are available (but 2014 remains the default).

  • (GH#197, GH#199, GH#200) Added more atomic units and aliases (e.g. au_length = bohr).

  • (GH#190, GH#191, GH#201) Slim molecules. Many fields in Molecule objects may be optionally inferred.

Bug Fixes

  • (GH#174) Fix compare_recursive for when expected is a list but computed is not.

  • (GH#177) Spelling and type hint fixes.

  • (GH#180) Better test coverage.

0.12.0 / 2019-11-13

New Features

Enhancements

  • (GH#156) Molecules can now be correctly compared with ==.

  • (GH#157) molparse.to_string Q-Chem dtype developed. Psi4 dtype now includes label and doesn’t have extraneous info for single fragment systems.

  • (GH#162) New protocol stdout added to ResultProtocols controlling whether stdout field (which generally contains the primary logfile, whether a program writes it to file or stdout) is returned.

  • (GH#165) The code base is now Black formatted.

Deprecations

  • (GH#156) Molecule.compare is deprecated and will be removed in v0.13.0.

  • (GH#167, GH#168) ResultInput, Result, Optimization have been removed in favor of AtomicInput, AtomicResult, and OptimizationResult and will be removed in v0.13.0.

Bug Fixes

  • (GH#170) ProtoModel subclasses now correctly allow custom __repr__ and __str__ methods.

  • (GH#164, GH#166) nglview-sdf molecule string format now correctly uses correct sdf format widths fixing some issues with very large molecules.

0.11.1 / 2019-10-28

Bug Fixes

  • (GH#152) Patches Molecule.from_file and Molecule.from_data to read XYZ+ format and correctly handle keyword arguments.

    Patches Molecule.to_file to write XYZ+ format as the default for XYZ and XYZ+ files.

0.11.0 / 2019-10-24

Enhancements

  • (GH#147) Updates Pydantic to the 1.0 release and fixes a number of breaking changes.

  • (GH#148) Switches from Py3dMoljs to NGLView for molecular visualization due to Jupyter Widget integration.

  • (GH#149) Adds statC and Debye to the units registry.

Bug Fixes

  • (GH#150) Patches which_import to correctly handle submodules.

0.10.0 / 2019-10-16

Enhancements

  • (GH#144) Allows which_import to handle submodules.

  • (GH#143) Allow testing complex numbers.

0.9.0 / 2019-10-01

New Features

  • (GH#137, GH#138) Coordinates can now be output in Turbomole format in addition to all other formats.

  • (GH#139) A wavefunction property have been added to the Result Model. Adds the ability for Engine and other programs to store and fetch wavefunction data.

  • (GH#140) Protocols have been added to QCInputSpecification which allows data to pre-pruned by different specifications. Main intention is to reduce wavefunction data which may be re-computed cheaply rather than storing all of it. This does change the input model, so requires a minor version bump.

Enhancements

  • (GH#132) BasisSet and Result’s documentations have been brought up to the standards of other models.

0.8.0 / 2019-09-13

New Features

  • (GH#123) QCElemental now passes MyPy!

  • (GH#127, GH#131) Adds van der Waals radii data available through vdwradii.get(atom) function.

Enhancements

Bug Fixes

  • (GH#125) Add back a consistency check that had been optimized out.

0.7.0 / 2019-08-23

Enhancements

  • (GH#118) Model string representations should be more user friendly and descriptive without overload the output.

  • (GH#119) The molparse.to_string keyword-arg return_data now returns molecule keywords for GAMESS and NWChem. The models.Molecule.to_string can use return_data now, too.

  • (GH#120) Auto documentation tech is now built into the ProtoModel and does not need an external function.

0.6.1 / 2019-08-19

Bug Fixes

  • (GH#114) The Numpy einsum calls reference the top level functions and not core C functions. This fixes an issue which can result in NumPy version dependencies.

0.6.0 / 2019-08-14

New Features

  • (GH#85, GH#87) Msgpack is a new serialization option for Models. Serialization defaults to msgpack when available (conda install msgpack-python [-c conda-forge]), falling back to JSON otherwise. This results in substantial speedups for both serialization and deserialization actions and should be a transparent replacement for users within Elemental itself.

Enhancements

  • (GH#78) Molecular alignments can now be aligned on the derivatives of vector components.

  • (GH#81) Testing is now operated both on the minimal supported and the latest released versions of dependencies.

  • (GH#82) Molecule fragment grouping is now disabled by default to match expected behavior.

  • (GH#84) Testing without internet connection should now pass since PubChem testing is skipped with no connection.

  • (GH#85) Molecule switches from lists to numpy arrays for internal storage of per-atom fields.

  • (GH#86) Molecule performance and memory enhancements through reduced validation times and LRU caching of common validations.

  • (GH#88, GH#109) The Molecule Model now has its attributes documented and in an on-the-fly manner derived from the Pydantic Schema of those attributes.

  • (GH#99, GH#100, GH#101, GH#102, GH#103, GH#104, GH#105, GH#106, GH#107) Various documentation, type hints, and small changes.

Bug Fixes

  • (GH#87) Molecule objects built from Schema are run through validators for consistency.

0.5.0 / 2019-07-16

Enhancements

  • (GH#76) Adds a built-in Molecule.to_file function for easy serialization into .numpy, .json, .xyz, .psimol, and .psi4 file formats.

Bug Fixes

  • (GH#74) Atom and fragment ordering are preserved when invoking get_fragment.

0.4.2 / 2019-06-13

New Features

  • (GH#70, GH#72) molparse.to_string Molpro dtype developed.

0.4.1 / 2019-05-31

New Features

Enhancements

  • (GH#68) molparse.to_string learned parameter return_data that contains aspects of the models.Molecule not expressible in the string. Implemented for dtypes xyz, cfour, psi4.

  • (GH#68) Datum gained an attribute numeric that reflects whether arithmetic on data is valid. Datums that aren’t numeric can now be created by initializing with numeric=False.

Bug Fixes

  • (GH#66) Fix tests when networkx not installed.

  • (GH#67) Fix “unsupported format string passed to numpy.ndarray.__format__” on Mac for testing.compare_values.

0.4.0 / 2019-05-13

New Features

  • (GH#51) Changes models.Molecule connectivity to default to None rather than an empty list. WARNING this change alters the hashes produced from the Molecule.get_hash functionality.

  • (GH#52, GH#53) models.Molecule learned nuclear_repulsion_energy, nelectrons, and to_string functions.

  • (GH#54) models.ResultProperties supports CCSD and CCSD(T) properties.

  • (GH#56) Algorithms Kabsch molutil.kabsch_align, Hungarian util.linear_sum_assignment, and Uno util.uno added. Utilities to generate random 3D rotations util.random_rotation_matrix and reindex a NumPy array into smaller blocks util.blockwise_expand added.

  • (GH#56) Molecular alignment taking into account displacement, rotation, atom exchange, and mirror symmetry for superimposable and differing geometries was added in molutil.B787 (basis NumPy function) and models.Molecule.align (far more convenient). Suitable for QM-sized molecules. Requires addition package networkx.

  • (GH#58) utils learned which_import and which that provide a path or boolean result for locating modules or commands, respectively. These were migrated from QCEngine along with safe_version and parse_version to colocate the import utilities.

  • (GH#61) Add molecular visualization to the models.Molecule object through the optional 3dMol.js framework.

  • (GH#65) testing.compare_molrecs learned parameter relative_geoms='align' that lets Molecules pass if geometries within a translation and rotation of each other.

  • (GH#65) testing.compare_recursive learned parameter forgive that is a list of paths that may differ without failing the comparison.

Enhancements

  • (GH#52, GH#53) molparse.to_string NWChem and GAMESS dtypes developed.

  • (GH#57) molparse.to_string learned dtype='terachem' for writing the separate XYZ file required by TeraChem. Angstroms or Bohr allowed, though the latter requires extra in input file.

  • (GH#60) util.which added the Python interpreter path to the default search $PATH.

  • (GH#62) Added * to parameter list of many functions requiring subsequent to be keyword only. Code relying heavily on positional arguments may get broken.

  • (GH#63) util.which learned parameter env to use an alternate search $PATH.

  • (GH#63) util.which and util.which_import learned parameters raise_error and raise_msg which raises ModuleNotFoundError (for both functions) when not located. It error will have a generic error message which can be extended by raise_msg. It is strongly encouraged to add specific remedies (like how to install) through this parameter. This is the third exit pattern possible from the “which” functions, of which path/None is the default, True/error happens when raise_error=True, and True/False happens otherwise when return_bool=True.

  • (GH#65) Testing functions compare, compare_values, compare_recursive learned parameter return_handler that lets other printing, logging, and pass/fail behavior to be interjected.

Bug Fixes

  • (GH#63) util.which uses os.pathsep rather than Linux-focused :.

  • (GH#65) Fixed some minor printing and tolerance errors in molecule alignment.

  • (GH#65) testing.compare_recursive stopped doing atol=10**-atol for atol>=1, bringing it in line with other compare functions.

0.3.3 / 2019-03-12

Enhancements

  • (GH#49) Precompute some mass number and mass lookups and store on qcel.periodic_table. Also move static re.compile expressions out of fns on to module. Mol validation .127s –> .005s.

0.3.2 / 2019-03-11

New Features

  • (GH#47) models.DriverEnum now has a derivative_int function to return 1 for gradient, etc., for easy math. properties returns 0.

  • (GH#47) Optional fix_symmetry field in qcschema_molecule was missing from models.Molecule so Pydantic got mad at Psi4. Now calmed.

Enhancements

  • (GH#48) If Molecule object has passed through molparse validation because it was created with a molparse constructor (e.g., from_string), save some time by not passing it through again at model.Molecule creation time.

Bug Fixes

  • (GH#48) Fixed a Molecule.get_fragment bug where ghosted fragments still asserted charge/multiplicity to the validator, which was rightly confused.

0.3.1 / 2019-03-07

Enhancements

  • (GH#37) Documentation now pulls from the custom QC Archive Sphinx Theme, but can fall back to the standard RTD theme. This allows all docs across QCA to appear consistent with each other.

  • (GH#41) Conda-build recipe removed to avoid possible confusion for everyone who isn’t a Conda-Forge recipe maintainer. Tests now rely on the conda env setups.

  • (GH#44) Molecule objects are now always validated against a more rigorous model and fragment multiplicities are fixed at the correct times, even when no multiplicities are provided. Molecule defaults to dtype=2.

Bug Fixes

  • (GH#39) Fixed setup.py to call pytest instead of unittest when running tests on install

  • (GH#41) Pinned a minimum Pytest version to make sure errors are not because of too old of a pytest version

0.3.0 / 2019-02-27

New Features

  • (GH#33) molparse.to_schema recognizes dtype=2 in keeping with GH:MolSSI/QCSchema#60 with internal schema_name=qcschema_molecule and schema_version=2 fields. molparse.from_schema recognizes external fields (existing functionality), internal fields (dtype=2), and mixed.

  • (GH#33) Pydantic molecule model now contains schema_name and schema_version=2 information.

  • (GH#35) Models now have an extra field for extra attributes, no additional base keys are allowed.

Enhancements

  • (GH#34) Converts qcel.Datum to Pydantic model. Changes: (a) comment, doi, glossary fields must be accessed by keyword, (b) to_dict() becomes dict() and instead of only label, units, data fields in dict, now comment, doi, glossary present _if_ non-default, (c) complex values no longer list-ified by to_dict().

  • (GH#36) Changelog and Models documentation.

Bug Fixes

0.2.6 / 2019-02-18

Bug Fixes

  • (GH#32) Updates compliance with Pydantic v0.20.

0.2.5 / 2019-02-13

Enhancements

  • (GH#31) Lints the code base preparing for a release and minor test improvements.

Bug Fixes

  • (GH#30) Fixes dihedral measurement code for incorrect phase in certain quadrants.

0.2.4 / 2019-02-08

New Features

  • (GH#27) Adds a new measure feature to Molecule for distances, angles, and dihedrals.

  • (GH#25) Adds a new testing module which contains testing routines for arrays, dictionaries, and molecules.

Enhancements

  • (GH#28) Reduces loading time from ~1 second to 200 ms by delaying pint import and ensuring git tags are only computed once.

0.2.3 / 2019-01-29

Enhancements

  • (GH#24) Update models to be compatible with QCFractal and MongoDB objects in the QCArchive Ecosystem. Also enhances the Molecule model’s json function to accept as_dict keyword, permitting a return as a dictionary of Pydantic-serialized python (primitive) objects, instead of a string.

0.2.2 / 2019-01-28

Bug Fixes

  • (GH#21) Molparse’s from_schema method now correctly parses the new qcschema_X strings for schema names.

  • (GH#23) Pydantic model serializations now correctly handle Numpy Array objects in nested BaseModels. Model serialization testing added to catch these in the future.

0.2.1 / 2019-01-27

  • (GH#20) Moves several Molecule parsing functions to the molparse module.

0.2.0 / 2019-01-25

  • now requires Python 3.6+

  • now requires Pydantic

New Features

  • (GH#14, GH#16, GH#17) Added new Pydantic models for Molecules, Results, and Optimizations to make common objects used in the QCArchive project all exist in one central, always imported module.

Enhancements

  • (GH#13) Function util.unnp that recursively list-ifies ndarray in a dict now handles lists and flattens.

0.1.3 / 2018-12-14

New Features

  • (GH#12) Adds “connectivity” validation and storage consistent with QCSchema.

Enhancements

  • (GH#12) Adds single dictionary provenance consistent with QCSchema (line 23) rather than previous list o’dicts.

0.1.2 / 2018-11-3

New Features

  • (GH#10) Adds covalent radii data available through covalentradii.get(atom) function.

  • (GH#10) Adds to_units(unit) to Datum class to access the data in non-native units.

  • (GH#10) Adds periodictable.to_period(atom) and to_group(atom) functions to address periodic table.

0.1.1 / 2018-10-30

New Features

  • (GH#7, GH#9) Adds “comment” and “provenance” fields to internal repr to better match QCSchema.

  • (GH#7) Adds provenance stamp to from_string, from_arrays, from_schema functions.

Enhancements

  • (GH#7) Adds outer schema_name/schema_version to to_schema(..., dtype=1) output so is inverse to from_schema.

Bug Fixes

  • (GH#8) Tests pass for installed module now that comparison tests are xfail.

0.1.0a / 2018-10-24

This is the first alpha release of QCElemental containing the primary three components.

New Features

  • (GH#6) Updated molparse to write new Molecule QCSchema fields in keeping with GH:MolSSI/QCSchema#44

  • Periodic Table data from NIST SRD144 (c. pre-2015?) collected into qcelemental.periodictable instance, with accessors to_Z, to_element, to_E, to_mass, to_A (and redundant accessors to_mass_number, to_atomic_number, to_symbol, to_name) in float and Decimal formats. Also includes functionality to write a corresponding “C” header.

  • Physical Constants data from NIST SRD121 (CODATA 2014) collected into qcelemental.constants instance, with access through qcelemental.constants.Faraday_constant (exact capitalization; float result) or get (free capitalization; float or Decimal result). Also includes functionality to write a corresponding “C” header.

  • molparse submodule where from_string, from_array, from_schema constructors parse and rearrange (if necessary) and validate molecule topology inputs from the QC and EFP domains into a QCSchema-like data structure. Current deficiencies from QCSchema are non-contiguous fragments and “provenance” fields. Accessors to_string and to_schema are highly customizable.

  • A pint context has been built around the NIST physical constants data so that qcelemental.constants.conversion_factor(from_unit, to_unit) uses the QCElemental values in its conversions. Resulting float is within uncertainty range of NIST constants but won’t be exact for conversions involving multiple fundamental dimensions or wavelength -> energy != 1 / (energy -> wavelength).