
Spruce TK 1.2.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* New methods have been added to :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`
  (:ref:`AddLipidCode  <OESpruce_OEDesignUnitSplitOptions_AddLipidCode>`,
  :ref:`SetLipidCodes  <OESpruce_OEDesignUnitSplitOptions_SetLipidCodes>`,
  :ref:`ClearLipidCodes  <OESpruce_OEDesignUnitSplitOptions_ClearLipidCodes>`, and
  :ref:`GetLipidCodes  <OESpruce_OEDesignUnitSplitOptions_GetLipidCodes>`).
  They allow users to specify the names of molecules to be
  considered as lipids.

* Support has been added for HEME and related cofactors in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>`. The state of HEME,
  contains two negatively charged nitrogens to balance the +2 Fe formal charge. The nitrogens coordinating
  the iron atom are indicated by zero-order bonds.

* A new function, :ref:`OEFindPockets <OESpruce_OEFindPockets>`, has been added that finds cavities in protein or nucleic acid complexes. The parameters
  for the search can be tuned with :ref:`OEPocketOptions <OESpruce_OEPocketOptions>`. The pockets are output as :ref:`OEPocket <OESpruce_OEPocket>` objects in an iterator.
  The function can take a predicate that will control only outputting pockets with a given set of residues or atoms in it. This function is also used in
  :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` when a site residue is provided.

* A new function, :ref:`OEMakeDesignUnitFromPocket  <OESpruce_OEMakeDesignUnitFromPocket>`, has been added that takes a prepared biological unit from
  an :ref:`OEMakeDesignUnit  <OESpruce_OEMakeDesignUnit>` and an :ref:`OEPocket <OESpruce_OEPocket>` and coverts it into an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  does with a reference structure.

* New methods have been added in :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`,
  :ref:`SetSeqAlignMethod  <OESpruce_OELoopBuilderOptions_SetSeqAlignMethod>`,
  :ref:`SetSeqAlignGapPenalty  <OESpruce_OELoopBuilderOptions_SetSeqAlignGapPenalty>`,
  :ref:`SetSeqAlignExtendPenalty  <OESpruce_OELoopBuilderOptions_SetSeqAlignExtendPenalty>`,
  :ref:`GetSeqAlignMethod  <OESpruce_OELoopBuilderOptions_GetSeqAlignMethod>`,
  :ref:`GetSeqAlignGapPenalty  <OESpruce_OELoopBuilderOptions_GetSeqAlignGapPenalty>`, and
  :ref:`GetSeqAlignExtendPenalty  <OESpruce_OELoopBuilderOptions_GetSeqAlignExtendPenalty>`
  that allow users to control the sequence alignment done to find gaps
  in protein structures related to loop modeling.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused some modeled loops to be missing the backbone NH hydrogen where the modeled loops were attached has been fixed.

* Fragment numbers for build loops have been fixed to be consistent with the anchor residues where the loops are inserted.

* A bug in :ref:`OEFixBackbone  <OESpruce_OEFixBackbone>` has been fixed to ensure that OXT atoms are always built on C-terminal residues.

* An issue with atom order for built pieces like loops or caps has been fixed to ensure that these are sequential with the location they are built.

* A bug in :ref:`OEBuildLoops  <OESpruce_OEBuildLoops>` that in specific situations caused incorrect detection of gaps in protein
  structures has been fixed. Additionally, options have been exposed in :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` to allows users
  to control the underlying sequence alignment in the event of a failure.

Minor bug fixes
--------------------------------------------------------------------------------
* Improvements have been made to standard amino acid residue perception when
  preparing structures.

* Site residues in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` are now being checked against all
  the biological units so one can serve as a reference for the rest.

* A bug in loop modeling that caused the function to create residues with identical residue numbers
  has been fixed. The function now properly builds using insertion codes.

* A bug in loop modeling that caused problems for the underlying sequence alignment code and incorrect
  loops when a single residue was floating in space between two gaps has been fixed.

* The chemical component dictionary used internally in :ref:`OEMakeDesignUnits  <OESpruce_OEMakeDesignUnits>` has been updated with the
  latest changes from the RCSB, including some fixes for incorrect entries in the source data based on
  rules and literature searches.

