Omega TK 2.8.0
================================================================================

New features (Preliminary API)
--------------------------------------------------------------------------------

The following new preliminary APIs have been added for macrocycle functionality in
the **Omega TK**:

* :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` and :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>`
  classes to generate a macrocycle molecule conformer ensemble

* :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` and :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>`
  classes to generate a single conformer structure of a macrocycle molecule

* ``OEConfGen::OEDuplicateScanner`` and ``OEConfGen::OEDuplicateScanOptions``
  classes to enable fast scanning and removal of duplicate conformers from a conformer ensemble

* :oe:func:`OEConfGen::OEIsMacrocycle` function to detect if a molecule contains a macrocycle

The following new preliminary APIs have been added to enhance small molecule conformer
generation functionality in the **Omega TK**:

* :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class to generate a fragment library

* :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` and :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` classes
  to generate small molecule conformers using a fragment library

* :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class to generate a single conformer structure
  of a small molecule

* :ref:`OEFragBuilder <OEConfGen_OEFragBuilder>` and :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>`
  classes to generate fragment conformers using distance geometry.
  The :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class combines multiple
  options related to building a fragment library for both
  :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` and :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`.

* :ref:`OETorDriver <OEConfGen_OETorDriver>` and :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` classes to
  generate small molecule conformer ensembles from torsion driving

* :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class to store options related to generating
  a single fragment structure

* :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class to store options related to generating
  a single ring fragment structure

* :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class to store options related to fixing part
  of the structure of small molecules during a conformational search

* :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class to store options for ensemble pruning during
  a small molecule conformational search

* :oe:constns:`OEConfGen::OEFragBuilderMode` namespace to set up
  :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` for specific uses

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

New additions and modifications have been made to existing APIs to enhance small molecule
conformer generation functionality in **Omega TK**:

* Three new modes, :oe:const:`OEConfGen::OEOmegaSampling::Pose`,
  :oe:const:`OEConfGen::OEOmegaSampling::ROCS`, and
  :oe:const:`OEConfGen::OEOmegaSampling::FastROCS`, have been added to the
  :oe:constns:`OEConfGen::OEOmegaSampling` namespace.

* A new torsion library based on the work of Wolfgang Guba has been added.
  A new namespace, :oe:constns:`OEConfGen::OETorLibType`, has been introduced
  to provide options for the choice of torsion library. Additionally, the
  :ref:`OETorLib <OEConfGen_OETorLib>` constructor now takes a torsion type value
  from the :oe:constns:`OEConfGen::OETorLibType` namespace. Also, a new overload of the
  :oe:meth:`OEConfGen::OETorLib::SetTorsionLibrary` method has been added
  to allow setting the desired torsion library from the
  above-mentioned namespace.

* The :oe:constns:`OEConfGen::OEOmegaForceFieldType` namespace has been
  replaced by the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace.
  The new namespace adds 4 new options for the
  force field used in the :ref:`OEOmega <OEConfGen_OEOmega>` class. These
  new options are based on a modified variation of the
  :ref:`OEMMFF94sParams <OEMolMMFF_OEMMFF94sParams>` parameters that prefers the
  appropriate axial/equatorial conformers for many molecules in
  :ref:`OEOmega <OEConfGen_OEOmega>`.


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

* The SMILES string hash in the internal fragment library in the :ref:`OEOmega <OEConfGen_OEOmega>`
  class has been updated to reflect the proper canonicalization of the fragments.  This
  ensures that :ref:`OEOmega <OEConfGen_OEOmega>` will always find the fragment in the
  library if it exists.

* The default search force field in the :ref:`OEOmega <OEConfGen_OEOmega>` class has been changed to
  the newly introduced :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`
  type to generate more appropriate axial/equatorial conformers.

* An issue that caused the :ref:`OEOmega <OEConfGen_OEOmega>` class to not honor the parity bits
  on relative stereo marked rings has been fixed.

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

* An issue that caused the :ref:`OEOmega <OEConfGen_OEOmega>` class to report the same warning about
  atoms multiple times has been fixed.

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

The following C++ and Python examples have been added to demonstrate using the
new preliminary APIs:

* New examples have been added to the :ref:`section_examples_macrocycles` section
  that generate a macrocycle conformer ensemble or a single macrocycle conformer.

* A new example has been added to the :ref:`section_examples_fraglib` section
  that generates fragment libraries.

* A new example has been added to the :ref:`section_examples_torsion` section
  that generates a conformer ensemble by torsion driving from a given 3D structure.
