
Spruce TK 1.3.0
================================================================================

*July 2021*

New features
--------------------------------------------------------------------------------

* A molecule-based API for :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` has been added.

* New high-level superposition APIs were added that unify the sequence-based
  (:ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`) and shape-based
  (:ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>`) APIs. This includes a new
  :ref:`OESuperpose <OESpruce_OESuperpose>` class that can calculate different types of structural
  superposition, a new :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class that allows the users
  to control various behaviors of the superposition calculation, such as the superposition 
  method, and a new :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` class that holds the transformation
  and scores of the superposition. More detailed changes are as follows:

  * The new :ref:`OESuperpose <OESpruce_OESuperpose>` class can take either :ref:`OEMol <OEChem_OEMol>` or
    :ref:`OEDesignUnit <OEBio_OEDesignUnit>` as the reference for the fit molecule. The reference molecule can be
    set by using the :ref:`SetupRef <OESpruce_OESuperPose_SetupRef>` method, and the superposition can be
    calculated via :ref:`OESuperpose <OESpruce_OESuperpose_Superpose>` with the fit molecule
    supplied as one of its arguments.

  * A new :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>` namespace was added that contains the constants
    for different superposition methods. Functions :ref:`OEGetSuperposeMethodName <OESpruce_OEGetSuperposeMethodName>`
    and :ref:`OEGetSuperposeMethodFromName <OESpruce_OEGetSuperposeMethodFromName>` were added to obtain the superposition
    method's name (as a string literal) from its designated constant and vice versa.

  * Methods
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidRMSD>`,
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidSeqScore>`, and
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions_SetValidTanimoto>`
    have been added.  These methods can be used to set score thresholds for validating
    superposition results in the new
    :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class. The validity of the superposition result can be obtained
    by :ref:`OESuperposeResults <OESpruce_OESuperposeResults_IsValid>` from the new :ref:`OESuperposeResults <OESpruce_OESuperposeResults>`
    class.

  * The new :ref:`OESuperpose <OESpruce_OESuperpose>` API returns an :ref:`OESuperposeResults <OESpruce_OESuperposeResults>` object
    that can be used to transform the fit molecule to its superposed position with its 
    :ref:`Transform <OESpruce_OESuperposeResults_Transform>` method. Alternatively, the users can use
    :ref:`GetRotMatrix <OESpruce_OESuperposeResults_GetRotMatrix>` and :ref:`GetTranslation <OESpruce_OESuperposeResults_GetTranslation>`
    to obtain the rotation matrix and translation vector, respectively, for their analyses. The RMSD and 
    sequence alignment score after the superposition can be obtained using :ref:`OESuperposeResults <OESpruce_OESuperposeResults>`'s
    :ref:`GetRMSD <OESpruce_OESuperposeResults_GetRMSD>` and :ref:`GetSeqScore <OESpruce_OESuperposeResults_GetSeqScore>` methods
    for sequence-based superpositions, and the Tanimoto score can be obtained using 
    :ref:`GetTanimoto <OESpruce_OESuperposeResults_GetTanimoto>`.

  Please refer to the documentation for more information on these new superposition APIs.


Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused the loop modeling algorithm to crash in rare instances has been fixed.

* Examples have been modified to use appropriate command-line arguments.

* An issue that caused style on :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects to disappear when
  calling :ref:`OEProtonateDesignUnit <OESpruce_OEProtonateDesignUnit>` has been fixed.

* An issue with the return value of superposition when two structures cannot be superposed has been fixed.
  It now properly returns a -1.00 RMSD.

* An issue in :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` that caused style
  to remain on both the previous binding site and the one defined from the pocket
  has been fixed.

* A bug in superposition that resulted in a crash when using site residues
  that were not present on a design unit has been fixed.

* A bug that kept the insert code from its anchor residue when there was an N-terminal cap
  has been fixed.


Documentation changes
--------------------------------------------------------------------------------

* Documentation has been added for the Iridium classification. :ref:`Iridium. <chapter_sprucetk_iridium>`

* Documentation has been added for the new superposition APIs. Superposition 
  related APIs are now fully supported. :ref:`Superposition. <chapter_sprucetk_superposition>`
