Szybki TK 1.9.2
================================================================================

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

* Two new classes, :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` and
  :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`, have been added to provide
  conformer free energy functionality.  The methods in
  :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` provide high-level functionality; those
  in :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>` provide finer
  control of the functionality.

  In general, the new conformer free energy functionality provides 2 new
  capabilities: (1) methods to estimate restriction free energy and
  (2) methods to find conformers similar to the one specified from a pool of
  minimum energy conformers.

* The :ref:`OEFreeFormConfOptions <OESz_OEFreeFormConfOptions>` API methods have been modified and
  enhanced with :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` and various
  :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` sub-options.  The enhanced API allows
  greater control over the details of free energy calculation.

* The :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` class has been simplified and now
  consists of various sub-options: :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`,
  :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`, :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`,
  and :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`.  The specific methods to set or
  get option values are now provided through these sub-option classes.

  The following table shows the older, deprecated option functions and their
  new sub-option replacements:

  =========================================================   ========================================================================
  Deprecated Option Method                                    New Sub-option Method
  ---------------------------------------------------------   ------------------------------------------------------------------------
  ``OESz::OESzybki::SetIEFFCluster``                          :oe:meth:`OESz::OESzybkiGeneralOptions::SetIEFFCluster`
  ``OESz::OESzybkiOptions::SetIEFFCluster``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetIEFFCluster`

  ``OESz::OESzybki::GetIEFFCluster``                          :oe:meth:`OESz::OESzybkiGeneralOptions::GetIEFFCluster`
  ``OESz::OESzybkiOptions::GetIEFFCluster``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetIEFFCluster`

  ``OESz::OESzybki::SetRemoveCoulombTerms``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveCoulombTerms`
  ``OESz::OESzybkiOptions::SetRemoveCoulombTerms``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveCoulombTerms`

  ``OESz::OESzybki::GetRemoveCoulombTerms``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveCoulombTerms`
  ``OESz::OESzybkiOptions::GetRemoveCoulombTerms``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveCoulombTerms`

  ``OESz::OESzybki::SetRemoveAttractiveVdWForces``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveAttractiveVdWForces`
  ``OESz::OESzybkiOptions::SetRemoveAttractiveVdWForces``     :oe:meth:`OESz::OESzybkiGeneralOptions::SetRemoveAttractiveVdWForces`

  ``OESz::OESzybki::GetRemoveAttractiveVdWForces``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveAttractiveVdWForces`
  ``OESz::OESzybkiOptions::GetRemoveAttractiveVdWForces``     :oe:meth:`OESz::OESzybkiGeneralOptions::GetRemoveAttractiveVdWForces`

  ``OESz::OESzybki::SetLigandRMSDHeavy``                      :oe:meth:`OESz::OESzybkiGeneralOptions::SetLigandRMSDHeavy`
  ``OESz::OESzybkiOptions::SetLigandRMSDHeavy``               :oe:meth:`OESz::OESzybkiGeneralOptions::SetLigandRMSDHeavy`

  ``OESz::OESzybki::GetLigandRMSDHeavy``                      :oe:meth:`OESz::OESzybkiGeneralOptions::GetLigandRMSDHeavy`
  ``OESz::OESzybkiOptions::GetLigandRMSDHeavy``               :oe:meth:`OESz::OESzybkiGeneralOptions::GetLigandRMSDHeavy`

  ``OESz::OESzybki::SetCalculateGradients``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`
  ``OESz::OESzybkiOptions::SetCalculateGradients``            :oe:meth:`OESz::OESzybkiGeneralOptions::SetCalculateGradients`

  ``OESz::OESzybki::GetCalculateGradients``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetCalculateGradients`
  ``OESz::OESzybkiOptions::GetCalculateGradients``            :oe:meth:`OESz::OESzybkiGeneralOptions::GetCalculateGradients`

  ``OESz::OESzybki::SetVerbose``                              :oe:meth:`OESz::OESzybkiGeneralOptions::SetVerbose`
  ``OESz::OESzybkiOptions::SetVerbose``                       :oe:meth:`OESz::OESzybkiGeneralOptions::SetVerbose`

  ``OESz::OESzybki::GetVerbose``                              :oe:meth:`OESz::OESzybkiGeneralOptions::GetVerbose`
  ``OESz::OESzybkiOptions::GetVerbose``                       :oe:meth:`OESz::OESzybkiGeneralOptions::GetVerbose`

  ``OESz::OESzybki::SetIntramolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiGeneralOptions::SetIntramolecularVdWCutoff`
  ``OESz::OESzybkiOptions::SetIntramolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiGeneralOptions::SetIntramolecularVdWCutoff`

  ``OESz::OESzybki::GetIntramolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiGeneralOptions::GetIntramolecularVdWCutoff`
  ``OESz::OESzybkiOptions::GetIntramolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiGeneralOptions::GetIntramolecularVdWCutoff`

  ``OESz::OESzybki::SetTemperature``                          :oe:meth:`OESz::OESzybkiGeneralOptions::SetTemperature`
  ``OESz::OESzybkiOptions::SetTemperature``                   :oe:meth:`OESz::OESzybkiGeneralOptions::SetTemperature`

  ``OESz::OESzybki::GetTemperature``                          :oe:meth:`OESz::OESzybkiGeneralOptions::GetTemperature`
  ``OESz::OESzybkiOptions::GetTemperature``                   :oe:meth:`OESz::OESzybkiGeneralOptions::GetTemperature`

  ``OESz::OESzybki::SetSoluteDielectric``                     :oe:meth:`OESz::OESzybkiGeneralOptions::SetSoluteDielectric`
  ``OESz::OESzybkiOptions::SetSoluteDielectric``              :oe:meth:`OESz::OESzybkiGeneralOptions::SetSoluteDielectric`

  ``OESz::OESzybki::GetSoluteDielectric``                     :oe:meth:`OESz::OESzybkiGeneralOptions::GetSoluteDielectric`
  ``OESz::OESzybkiOptions::GetSoluteDielectric``              :oe:meth:`OESz::OESzybkiGeneralOptions::GetSoluteDielectric`

  ``OESz::OESzybki::SetForceFieldType``                       :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`
  ``OESz::OESzybkiOptions::SetForceFieldType``                :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`

  ``OESz::OESzybki::GetForceFieldType``                       :oe:meth:`OESz::OESzybkiGeneralOptions::GetForceFieldType`
  ``OESz::OESzybkiOptions::GetForceFieldType``                :oe:meth:`OESz::OESzybkiGeneralOptions::GetForceFieldType`

  ``OESz::OESzybki::SetCalculateFrozenTerms``                 :oe:meth:`OESz::OESzybkiOptOptions::SetCalculateFrozenTerms`
  ``OESz::OESzybkiOptions::SetCalculateFrozenTerms``          :oe:meth:`OESz::OESzybkiOptOptions::SetCalculateFrozenTerms`

  ``OESz::OESzybki::GetCalculateFrozenTerms``                 :oe:meth:`OESz::OESzybkiOptOptions::GetCalculateFrozenTerms`
  ``OESz::OESzybkiOptions::GetCalculateFrozenTerms``          :oe:meth:`OESz::OESzybkiOptOptions::GetCalculateFrozenTerms`

  ``OESz::OESzybki::SetGradTolerance``                        :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`
  ``OESz::OESzybkiOptions::SetGradTolerance``                 :oe:meth:`OESz::OESzybkiOptOptions::SetGradTolerance`

  ``OESz::OESzybki::GetGradTolerance``                        :oe:meth:`OESz::OESzybkiOptOptions::GetGradTolerance`
  ``OESz::OESzybkiOptions::GetGradTolerance``                 :oe:meth:`OESz::OESzybkiOptOptions::GetGradTolerance`

  ``OESz::OESzybki::SetOptimizerType``                        :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`
  ``OESz::OESzybkiOptions::SetOptimizerType``                 :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`

  ``OESz::OESzybki::GetOptimizerType``                        :oe:meth:`OESz::OESzybkiOptOptions::GetOptimizerType`
  ``OESz::OESzybkiOptions::GetOptimizerType``                 :oe:meth:`OESz::OESzybkiOptOptions::GetOptimizerType`

  ``OESz::OESzybki::SetMaxIter``                              :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter`
  ``OESz::OESzybkiOptions::SetMaxIter``                       :oe:meth:`OESz::OESzybkiOptOptions::SetMaxIter`

  ``OESz::OESzybki::GetMaxIter``                              :oe:meth:`OESz::OESzybkiOptOptions::GetMaxIter`
  ``OESz::OESzybkiOptions::GetMaxIter``                       :oe:meth:`OESz::OESzybkiOptOptions::GetMaxIter`

  ``OESz::OESzybki::SetSolventDielectric``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventDielectric`
  ``OESz::OESzybkiOptions::SetSolventDielectric``             :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventDielectric`

  ``OESz::OESzybki::GetSolventDielectric``                    :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventDielectric`
  ``OESz::OESzybkiOptions::GetSolventDielectric``             :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventDielectric`

  ``OESz::OESzybki::SetSaltConcentration``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetSaltConcentration`
  ``OESz::OESzybkiOptions::SetSaltConcentration``             :oe:meth:`OESz::OESzybkiSolventOptions::SetSaltConcentration`

  ``OESz::OESzybki::GetSaltConcentration``                    :oe:meth:`OESz::OESzybkiSolventOptions::GetSaltConcentration`
  ``OESz::OESzybkiOptions::GetSaltConcentration``             :oe:meth:`OESz::OESzybkiSolventOptions::GetSaltConcentration`

  ``OESz::OESzybki::SetCavitySolventParameter``               :oe:meth:`OESz::OESzybkiSolventOptions::SetCavitySolventParameter`
  ``OESz::OESzybkiOptions::SetCavitySolventParameter``        :oe:meth:`OESz::OESzybkiSolventOptions::SetCavitySolventParameter`

  ``OESz::OESzybki::GetCavitySolventParameter``               :oe:meth:`OESz::OESzybkiSolventOptions::GetCavitySolventParameter`
  ``OESz::OESzybkiOptions::GetCavitySolventParameter``        :oe:meth:`OESz::OESzybkiSolventOptions::GetCavitySolventParameter`

  ``OESz::OESzybki::SetSolventModel``                         :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventModel`
  ``OESz::OESzybkiOptions::SetSolventModel``                  :oe:meth:`OESz::OESzybkiSolventOptions::SetSolventModel`

  ``OESz::OESzybki::GetSolventModel``                         :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventModel`
  ``OESz::OESzybkiOptions::GetSolventModel``                  :oe:meth:`OESz::OESzybkiSolventOptions::GetSolventModel`

  ``OESz::OESzybki::SetAtomicRadii``                          :oe:meth:`OESz::OESzybkiSolventOptions::SetAtomicRadiiType`
  ``OESz::OESzybkiOptions::SetAtomicRadii``                   :oe:meth:`OESz::OESzybkiSolventOptions::SetAtomicRadiiType`

  ``OESz::OESzybki::GetAtomicRadiiType``                      :oe:meth:`OESz::OESzybkiSolventOptions::GetAtomicRadiiType`
  ``OESz::OESzybkiOptions::GetAtomicRadiiType``               :oe:meth:`OESz::OESzybkiSolventOptions::GetAtomicRadiiType`

  ``OESz::OESzybki::SetUseCurrentCharges``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::SetUseCurrentCharges``             :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::GetUseCurrentCharges``                    :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::GetUseCurrentCharges``             :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::SetEveryConfAM1BCCCharges``               :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::SetEveryConfAM1BCCCharges``        :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybki::GetEveryConfAM1BCCCharges``               :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`
  ``OESz::OESzybkiOptions::GetEveryConfAM1BCCCharges``        :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine`

  ``OESz::OESzybki::SetExactVdWProteinLigand``                :oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`
  ``OESz::OESzybkiOptions::SetExactVdWProteinLigand``         :oe:meth:`OESz::OESzybkiProteinOptions::SetExactVdWProteinLigand`

  ``OESz::OESzybki::GetExactVdWProteinLigand``                :oe:meth:`OESz::OESzybkiProteinOptions::GetExactVdWProteinLigand`
  ``OESz::OESzybkiOptions::GetExactVdWProteinLigand``         :oe:meth:`OESz::OESzybkiProteinOptions::GetExactVdWProteinLigand`

  ``OESz::OESzybki::SetProteinDielectric``                    :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinDielectric`
  ``OESz::OESzybkiOptions::SetProteinDielectric``             :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinDielectric`

  ``OESz::OESzybki::GetProteinDielectric``                    :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinDielectric`
  ``OESz::OESzybkiOptions::GetProteinDielectric``             :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinDielectric`

  ``OESz::OESzybki::SetProteinFlexibilityRange``              :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`
  ``OESz::OESzybkiOptions::SetProteinFlexibilityRange``       :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityRange`

  ``OESz::OESzybki::GetProteinFlexibilityRange``              :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityRange`
  ``OESz::OESzybkiOptions::GetProteinFlexibilityRange``       :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityRange`

  ``OESz::OESzybki::SetIntermolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiProteinOptions::SetIntermolecularVdWCutoff`
  ``OESz::OESzybkiOptions::SetIntermolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiProteinOptions::SetIntermolecularVdWCutoff`

  ``OESz::OESzybki::GetIntermolecularVdWCutoff``              :oe:meth:`OESz::OESzybkiProteinOptions::GetIntermolecularVdWCutoff`
  ``OESz::OESzybkiOptions::GetIntermolecularVdWCutoff``       :oe:meth:`OESz::OESzybkiProteinOptions::GetIntermolecularVdWCutoff`

  ``OESz::OESzybki::SetProteinElectrostaticModel``            :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`
  ``OESz::OESzybkiOptions::SetProteinElectrostaticModel``     :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinElectrostaticModel`

  ``OESz::OESzybki::GetProteinElectrostaticModel``            :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinElectrostaticModel`
  ``OESz::OESzybkiOptions::GetProteinElectrostaticModel``     :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinElectrostaticModel`

  ``OESz::OESzybki::SetProteinFlexibilityType``               :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`
  ``OESz::OESzybkiOptions::SetProteinFlexibilityType``        :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`

  ``OESz::OESzybki::GetProteinFlexibilityType``               :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityType`
  ``OESz::OESzybkiOptions::GetProteinFlexibilityType``        :oe:meth:`OESz::OESzybkiProteinOptions::GetProteinFlexibilityType`
  =========================================================   ========================================================================

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

* User-defined partial charges set for the MMFFS_AMBER or
  MMFF_AMBER force field calculations had previously not been preserved.
  They are now passed to the optimized molecule.

* Changing the protein flexibility type from range-defined to a list of
  residues for an :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` object previously required
  creating a copy of the object. This issue has been fixed.

* Atomic radii for IEFF/PB calculations were previously restricted to
  the Bondi type.  Although the default is still Bondi, ZAP7 and ZAP9 radii are
  now available.
