Metadata-Version: 2.4
Name: composite_step
Version: 2026.11.12.1
Summary: A SEAMM plug-in for composite methods: energies from recipes of ordinary calculations
Home-page: https://github.com/molssi-seamm/composite_step
Author: Paul Saxe
Author-email: psaxe@molssi.org
License: BSD-3-Clause
Keywords: SEAMM,SEAMMplugin,flowchart
Platform: Linux
Platform: Mac OS-X
Platform: Unix
Platform: Windows
Classifier: Environment :: Plugins
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: seamm
Requires-Dist: seamm-util
Requires-Dist: seamm-widgets
Requires-Dist: pyyaml
Requires-Dist: seamm-exec>=2026.11.12
Requires-Dist: model-chemistry-step
Requires-Dist: stevedore
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

=======================
SEAMM Composite Plug-in
=======================

.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/composite_step
   :target: https://github.com/molssi-seamm/composite_step/pulls
   :alt: GitHub pull requests

.. image:: https://github.com/molssi-seamm/composite_step/workflows/CI/badge.svg
   :target: https://github.com/molssi-seamm/composite_step/actions
   :alt: Build Status

.. image:: https://codecov.io/gh/molssi-seamm/composite_step/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/molssi-seamm/composite_step
   :alt: Code Coverage

.. image:: https://github.com/molssi-seamm/composite_step/workflows/CodeQL/badge.svg
   :target: https://github.com/molssi-seamm/composite_step/security/code-scanning
   :alt: Code Quality

.. image:: https://github.com/molssi-seamm/composite_step/workflows/Release/badge.svg
   :target: https://molssi-seamm.github.io/composite_step/index.html
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/composite_step.svg
   :target: https://pypi.python.org/pypi/composite_step
   :alt: PyPi VERSION

A SEAMM plug-in for composite methods: energies from recipes of ordinary calculations

* Free software: BSD-3-Clause
* Documentation: https://molssi-seamm.github.io/composite_step/index.html
* Code: https://github.com/molssi-seamm/composite_step

Features
--------

* Composite methods as model chemistries, ``SEAMM:CMP@<recipe>``, from recipes:
  short YAML files that say how the energy is made from ordinary calculations.
* A small, checked language for combining the energies: basis-set extrapolations
  (inverse power, exponential HF, Schwenke), scaling and empirical terms.
* Components are ordinary calculations with their own settings fingerprints, so
  the fragment store reuses them.
* The shipped recipes ``r2SCAN-3c-HO`` and ``revDSD-r2SCAN-3c-HO``, the
  Thermochemistry step's ``quick`` and ``default`` presets.

Acknowledgements
----------------

This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
is based on the excellent Cookiecutter_.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin

Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the `National Science Foundation`_ under
award CHE-2136142.

.. _MolSSI: https://molssi.org
.. _`National Science Foundation`: https://www.nsf.gov


=======
History
=======
2026.11.12.1 -- Recipes that use the parts of an energy
    * Recipes can use the parts of a component's energy: ``part(c, "name")`` for
      the HF energy, the CABS singles, the correlation energies and the triples that
      the program reports, and parts derived from them (the CCSD-F12 correlation, the
      scaled triples (T*), ...). ``hf_part(c)`` is the HF energy and ``corr_part(c)``
      the correlation alone, so a recipe can, for example, extrapolate the
      correlation energy and not the HF energy.
    * A recipe that splits an F12 calculation into HF and correlation must account
      for its CABS singles, and the HF parts of components with different references
      cannot be combined unless the recipe allows it; such recipes are refused when
      they are read.
    * A stored energy without the parts a recipe needs is computed again; parts are
      never derived.

2026.11.12 -- Recipes that combine several calculations run in every step
    * A composite recipe that combines several calculations now runs wherever a
      model chemistry is used: the Energy step, the Thermochemistry step's CBH
      approach, and the others that run model chemistries through seamm-exec's
      Evaluator. Each component runs as one batch of its own program over all the
      structures, the cheapest first, with that program's own memory and cores.
    * A structure that fails one component is not sent to the later ones, and its
      result names the component that failed.
    * Every result carries the composite record: the recipe's fingerprint and every
      component's settings fingerprint, in the same form whether the recipe has one
      component or several, and whether a component was computed or found in a
      store.
    * A user's or a job's own recipe (in a ``recipes`` directory of SEAMM's data
      path) is found wherever its model chemistry runs.
    * Needs seamm-exec 2026.11.12 or later for recipes with several components.

2026.11.11 -- First release: composite methods as model chemistries
    * Composite methods are described by recipes, short YAML files that say how the
      energy is made from ordinary calculations: the geometry and frequency level,
      single points at that geometry, and a formula that combines them, with
      basis-set extrapolations, scaling and empirical terms.
    * Every recipe is a model chemistry, ``SEAMM:CMP@<recipe>``, for the steps that
      take one. Its components are ordinary calculations with their own settings
      fingerprints, so the fragment store reuses them.
    * The recipes ``r2SCAN-3c-HO`` and ``revDSD-r2SCAN-3c-HO`` are shipped; they are
      the Thermochemistry step's ``quick`` and ``default`` presets.
    * The Composite step itself does nothing yet and is not offered in the editor.
