
.. _section_oedocking_releasenotes_4002:

OEDocking TK 4.0.0.2
================================================================================

*March 2021*

* Default value of :oe:meth:`Target Mask<OEDocking::OEMakeReceptorOptions::SetTargetMask>`
  has been changed to :oe:const:`OEBio::OEDesignUnitComponents::TargetComplexNoSolvent`, to
  reflect best practices for receptor generation.

* :oe:meth:`Target Mask<OEDocking::OEMakeReceptorOptions::SetTargetMask>` in
  :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` now provides added
  flexibility to create user defined mask.

* An issue causing :ref:`OEPosit <OEDocking_OEPosit>` to occasionally ignore the
  :oe:meth:`Posit Methods<OEDocking::OEPositOptions::SetPositMethods>` has been fixed.

* Constraints (both protein constraints and custom constraints) are now properly
  serialized in the :ref:`OEReceptor <OEBio_OEReceptor>` in a .OEDU file.

* All of the protein constraints, custom constraints, and extra molecules are now
  properly transferred in the :ref:`OEReceptor <OEBio_OEReceptor>` and the :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
  when OEB format receptors are used.

.. _section_oedocking_releasenotes_400:

OEDocking TK 4.0.0
================================================================================

*Fall 2020*

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

* A new class, :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`, has been added that provides
  choices for making an :ref:`OEReceptor <OEBio_OEReceptor>` inside an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`.

* The :oe:func:`OEDocking::OEMakeReceptor` function now takes an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  and an :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>`, and adds an :ref:`OEReceptor <OEBio_OEReceptor>`
  inside the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object.

* A new class, :ref:`OEDockOptions <OEDocking_OEDockOptions>`, has been introduced that provides
  choices for :oe:constns:`OEDocking::OEDockMethod` and :oe:constns:`OEDocking::OESearchResolution`
  in the :ref:`OEDock <OEDocking_OEDock>` class.

* The :ref:`OEDock <OEDocking_OEDock>` class constructor now has an overload
  that takes an :ref:`OEDockOptions <OEDocking_OEDockOptions>` argument.

* The following methods now have an overload that accepts as an argument an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`
  containing an :ref:`OEReceptor <OEBio_OEReceptor>`:

  * :oe:meth:`OEDocking::OEDock::Initialize`
  * :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
  * :oe:meth:`OEDocking::OEScore::Initialize`
  * :oe:meth:`OEDocking::OEScore::CacheScoringSetup`
  * :oe:meth:`OEDocking::OEPosit::AddReceptor`

* A new method, :oe:meth:`OEDocking::OESinglePoseResult::GetDesignUnit`, has been added added that
  returns the resulting design unit containing the pose ligand and the target.

* A new class, :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>`, has been added that provides choices for
  force fields and flexibility in performing pose optimization with
  :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>`.

* The :ref:`OEPoseOptimizer <OEDocking_OEPoseOptimizer>` class constructor now has an overload
  that takes an :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>`.

* The :oe:meth:`OEDocking::OEPoseOptimizer::Optimize` method now takes an
  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` to optimize.

* Flexible **POSIT** with :oe:meth:`OEDocking::OEPosit::Dock` now uses the
  :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>` for pose optimization.

* A new method, :oe:meth:`OEDocking::OEPosit::RankDesignUnits`, has been added
  that ranks an  :ref:`OEDesignUnit <OEBio_OEDesignUnit>` containing an :ref:`OEReceptor <OEBio_OEReceptor>` for
  posing with multiple receptors.

* With the introduction of the new :ref:`OEReceptor <OEBio_OEReceptor>` class and the corresponding
  behavior of the **OEDocking TK**, several previously existing APIs have been deprecated.
  The following table shows the deprecated APIs and their replacements:

  =========================================================   ================================================================
  Deprecated API                                              New API
  ---------------------------------------------------------   ----------------------------------------------------------------
  ``OEDocking::OEBoxBase``                                    :ref:`OEBox <OEMath_OEBox>`
  ``OEDocking::OEBox``

  ``OEDocking::OECustomConstraints``                          :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>`

  ``OEDocking::OEFeature``                                    :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`

  ``OEDocking::OEProteinConstraint``                          :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`

  ``OEDocking::OESphereBase``                                 :ref:`OESphere <OEMath_OESphere>`

  ``OEDocking::OEAlignReceptors``                             :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`

  ``OEDocking::OEIsReceptor``                                 :oe:meth:`OEBio::OEDesignUnit::HasReceptor`

  ``OEDocking::OEReceptorClear``                              :oe:meth:`OEBio::OEReceptor::Clear`

  ``OEDocking::OEReceptorClearCustomConstraints``             :oe:meth:`OEBio::OEReceptor::ClearCustomConstraints`

  ``OEDocking::OEReceptorClearProteinConstraints``            :oe:meth:`OEBio::OEReceptor::ClearProteinConstraints`

  ``OEDocking::OEReceptorGetBoundLigand``                     :oe:meth:`OEBio::OEDesignUnit::GetLigand`

  ``OEDocking::OEReceptorGetCustomConstraints``               :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>`

  ``OEDocking::OEReceptorGetInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::GetInnerContourLevel`

  ``OEDocking::OEReceptorGetOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::GetOuterContourLevel`

  ``OEDocking::OEReceptorHasBoundLigand``                     :oe:meth:`OEBio::OEDesignUnit::HasLigand`

  ``OEDocking::OEReceptorHasCustomConstraints``               :oe:meth:`OEBio::OEReceptor::HasCustomConstraints`

  ``OEDocking::OEReceptorHasInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::HasInnerContourLevel`

  ``OEDocking::OEReceptorHasNegativeImageGrid``               :oe:meth:`OEBio::OEReceptor::HasNegativeImageGrid`

  ``OEDocking::OEReceptorHasOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::HasOuterContourLevel`

  ``OEDocking::OEReceptorHasProteinConstraints``              :oe:meth:`OEBio::OEReceptor::HasProteinConstraints`

  ``OEDocking::OEReceptorSetCustomConstraints``               :oe:meth:`OEBio::OEReceptor::SetCustomConstraints`

  ``OEDocking::OEReceptorSetInnerContourLevel``               :oe:meth:`OEBio::OEReceptor::SetInnerContourLevel`

  ``OEDocking::OEReceptorSetOuterContourLevel``               :oe:meth:`OEBio::OEReceptor::SetOuterContourLevel`

  ``OEDocking::OEReceptorAddCachedScore``                     :oe:meth:`OEDocking::OEDock::CacheScoringSetup`
  ``OEDocking::OEReceptorSetCachedScore``                     :oe:meth:`OEDocking::OEScore::CacheScoringSetup`

  ``OEDocking::OEReadReceptorFile``                           :oe:func:`OEBio::OEReadDesignUnit`
  ``OEDocking::OEReadReceptorToBytes``

  ``OEDocking::OEWriteReceptorFile``                          :oe:func:`OEBio::OEWriteDesignUnit`
  ``OEDocking::OEWriteReceptorToBytes``

  ``OEDocking::OEBoxArea``                                    :oe:func:`OEMath::OEBoxArea`

  ``OEDocking::OEBoxExtend``                                  :oe:func:`OEMath::OEBoxExtend`

  ``OEDocking::OEBoxTranslate``                               :oe:func:`OEMath::OEBoxTranslate`

  ``OEDocking::OEBoxVolume``                                  :oe:func:`OEMath::OEBoxVolume`

  ``OEDocking::OEBoxXDim``                                    :oe:func:`OEMath::OEBoxXDim`

  ``OEDocking::OEBoxYDim``                                    :oe:func:`OEMath::OEBoxYDim`

  ``OEDocking::OEBoxZDim``                                    :oe:func:`OEMath::OEBoxZDim`

  ``OEDocking::OEBoxXMid``                                    :oe:func:`OEMath::OEBoxXMid`

  ``OEDocking::OEBoxYMid``                                    :oe:func:`OEMath::OEBoxYMid`

  ``OEDocking::OEBoxZMid``                                    :oe:func:`OEMath::OEBoxZMid`

  ``OEDocking::OEInBox``                                      :oe:func:`OEMath::OEInBox`

  ``OEDocking::OESetupBox``                                   :oe:func:`OEMath::OESetupBox`
  ``OEDocking::OESetupBoxCenterAndExtents``

  ``OEDocking::OEInSphere``                                   :oe:func:`OEMath::OEInSphere`

  ``OEDocking::OESphereArea``                                 :oe:func:`OEMath::OESphereArea`

  ``OEDocking::OESphereVolume``                               :oe:func:`OEMath::OESphereVolume`
  =========================================================   ================================================================

* With the introduction of the new APIs, several obsolete functionalities
  have been deprecated without any suitable replacements.  These functionalities were added in
  the early development days of **OEDocking TK** and are no longer deemed useful:

  * ``OEDocking::OEAlignReceptorFunction``
  * ``OEDocking::OEReceptorAddExtraMols``
  * ``OEDocking::OEReceptorClearBoundLigand``
  * ``OEDocking::OEReceptorClearExtraMols``
  * ``OEDocking::OEReceptorHasExtraMols``

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

* The :ref:`OEHybrid <OEDocking_OEHybrid>` class documentation has been modified to
  clarify that it is derived from :ref:`OEDock <OEDocking_OEDock>`.

* Documentation for ``OEDocking::OEDockBase`` and ``OEDocking::OEScoreBase``
  has been removed.

* All the **OEDocking TK** examples have been reorganized to reflect the
  modified API behavior.

