..  _chapter_omega_examples:

**************
OMEGA Examples
**************

The following table lists the currently available **Omega TK** examples:

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`simple_omega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`single_conformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`dens_omega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`stereo_and_torsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`torsion_drive<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`make_fraglib<section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`macrocycle<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`single_conf_macrocycle<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`simple_omega.py<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`single_conformer.py<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`dens_omega.py<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`stereo_and_torsion.py<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`torsion_drive.py<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`make_fraglib.py<section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`macrocycle.py<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`single_conf_macrocycle.py<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SimpleOmega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`SingleConformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`DensOmega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`StereoAndTorsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`TorsionDrive <section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`MakeFraglib <section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`Macrocycle <section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`SingleConformerMacrocycle <section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. oe:language:: csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SimpleOmega<section_examples_simple_omega>`
        - Generating conformers

      * - :ref:`SingleConformer<section_examples_single_conformer>`
        - Generating a single conformer

      * - :ref:`DensOmega<section_examples_dens_omega>`
        - Generating densely sampled conformers

      * - :ref:`StereoAndTorsion<section_examples_stereo_and_torsion>`
        - Generating stereoisomers

      * - :ref:`TorsionDrive<section_examples_torsion_drive>`
        - Generating conformer ensembles using torsion driving

      * - :ref:`MakeFraglib <section_examples_make_fraglib>`
        - Making fragment library

      * - :ref:`Macrocycle<section_examples_macrocycle>`
        - Generating macrocycle conformers

      * - :ref:`SingleConformerMacrocycle<section_examples_single_conf_macrocycle>`
        - Generating single macrocycle conformer

.. note::

      If the input molecule has SD tag data, the data will be copied to every conformer in the results molecule.


Classic OEOmega Examples
========================

.. _section_examples_simple_omega:

Generating Conformers
---------------------

The following code example is a simple illustration of how to generate conformers
using the :ref:`OEOmega <OEConfGen_OEOmega>` object.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: simple_omega.cpp
   :language: c++
   :caption:  Generating Conformers
   :refnum:   1


.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_omega.cpp <../../../../sublibs/tklibs/omega2/examples/simple_omega.cpp>`



.. oe:source:: simple_omega.py
   :language: python
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`simple_omega.py <../../../../wrappers/python/examples/omega/simple_omega.py>`



.. oe:source:: SimpleOmega.java
   :language: java
   :caption:  Generating Conformers
   :refnum:   1

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleOmega.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SimpleOmega.java>`



.. oe:source:: SimpleOmega.cs
   :language: csharp
   :caption:  Generating Conformers
   :refnum:   1


.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SimpleOmega.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SimpleOmega.cs>`



.. _section_examples_single_conformer:

Generating a Single Conformer
-----------------------------

The following code example is a simple illustration of how to generate a
single conformer.

.. seealso::

   * :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class

.. oe:source:: single_conformer.cpp
   :language: c++
   :caption:  Generating a Single Conformer
   :refnum:   2


.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conformer.cpp <../../../../sublibs/tklibs/omega2/examples/single_conformer.cpp>`



.. oe:source:: single_conformer.py
   :language: python
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conformer.py <../../../../wrappers/python/examples/omega/single_conformer.py>`


.. oe:source:: SingleConformer.java
   :language: java
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformer.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SingleConformer.java>`


.. oe:source:: SingleConformer.cs
   :language: csharp
   :caption:  Generating a Single Conformer
   :refnum:   2

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformer.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SingleConformer.cs>`


.. _section_examples_dens_omega:

Generating Densely Sampled Conformers
-------------------------------------

The following code example is a simple illustration of how to generate densely sampled
conformers, as used in :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` calculations, using the
:ref:`OEOmega <OEConfGen_OEOmega>` object.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :oe:constns:`OEConfGen::OEOmegaSampling` namespace
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: dense_omega.cpp
   :language: c++
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dense_omega.cpp <../../../../sublibs/tklibs/omega2/examples/dense_omega.cpp>`


.. oe:source:: dense_omega.py
   :language: python
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`dense_omega.py <../../../../wrappers/python/examples/omega/dense_omega.py>`


.. oe:source:: DenseOmega.java
   :language: java
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DenseOmega.java <../../../../wrappers/java/examples/openeye/examples/oeomega/DenseOmega.java>`


.. oe:source:: DenseOmega.cs
   :language: csharp
   :caption:  Generating Densely Sampled Conformers
   :refnum:   3

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`DenseOmega.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/DenseOmega.cs>`


Flipper Examples
================================================================================

.. _section_examples_stereo_and_torsion:

Generating Stereoisomers
------------------------

The following code example is a simple illustration of how to use the
:ref:`OEFlipper <OEConfGen_OEFlipper>` function to generate stereoisomers. The
code example also demonstrates that stereoisomers should be generated
before generating conformers.

.. seealso::

   * :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class
   * :ref:`OEOmega <OEConfGen_OEOmega>` class
   * :ref:`OEFlipper <OEConfGen_OEFlipper>` function
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: stereo_and_torsion.cpp
   :language: c++
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stereo_and_torsion.cpp <../../../../sublibs/tklibs/omega2/examples/stereo_and_torsion.cpp>`


.. oe:source:: stereo_and_torsion.py
   :language: python
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`stereo_and_torsion.py <../../../../wrappers/python/examples/omega/stereo_and_torsion.py>`


.. oe:source:: StereoAndTorsion.java
   :language: java
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StereoAndTorsion.java <../../../../wrappers/java/examples/openeye/examples/oeomega/StereoAndTorsion.java>`


.. oe:source:: StereoAndTorsion.cs
   :language: csharp
   :caption:  Generating Stereoisomers
   :refnum:   4

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`StereoAndTorsion.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/StereoAndTorsion.cs>`



.. _section_examples_torsion:

Generating Torsion Driven Conformation Examples
===============================================

.. _section_examples_torsion_drive:

Generating Conformer Ensembles Using Torsion Driving
-----------------------------------------------------

The following code example is a simple illustration of how torsion
driving from a given 3D structure can be used to generate a conformer ensemble.

.. seealso::

   * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class
   * :ref:`OETorDriver <OEConfGen_OETorDriver>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: torsion_drive.cpp
   :language: c++
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`torsion_drive.cpp <../../../../sublibs/tklibs/omega2/examples/torsion_drive.cpp>`



.. oe:source:: torsion_drive.py
   :language: python
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`torsion_drive.py <../../../../wrappers/python/examples/omega/torsion_drive.py>`



.. oe:source:: TorsionDrive.java
   :language: java
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`TorsionDrive.java <../../../../wrappers/java/examples/openeye/examples/oeomega/TorsionDrive.java>`



.. oe:source:: TorsionDrive.cs
   :language: csharp
   :caption:  Generating Conformer Ensembles Using Torsion Driving
   :refnum:   5

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`TorsionDrive.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/TorsionDrive.cs>`



.. _section_examples_fraglib:

Fragment Library Generation Examples
====================================

.. _section_examples_make_fraglib:

Making a Fragment Library
--------------------------

The following code example is a simple illustration of how to generate
a fragment library.

.. seealso::

   * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class
   * :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: make_fraglib.cpp
   :language: c++
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_fraglib.cpp <../../../../sublibs/tklibs/omega2/examples/make_fraglib.cpp>`



.. oe:source:: make_fraglib.py
   :language: python
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`make_fraglib.py <../../../../wrappers/python/examples/omega/make_fraglib.py>`



.. oe:source:: MakeFraglib.java
   :language: java
   :caption:  Making a Fragment Library
   :refnum:   6

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFraglib.java <../../../../wrappers/java/examples/openeye/examples/oeomega/MakeFraglib.java>`



.. oe:source:: MakeFraglib.cs
   :language: csharp
   :caption:  Making a Fragment Library
   :refnum:   6


.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFraglib.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/MakeFraglib.cs>`




.. _section_examples_macrocycles:

Macrocycle Examples
===================

.. _section_examples_macrocycle:

Generating Macrocycle Conformers
--------------------------------

The following code example is a simple illustration of how to generate conformers
using the OEMacrocycleOmega object.

.. seealso::

   * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
   * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: macrocycle.cpp
   :language: c++
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`macrocycle.cpp <../../../../sublibs/tklibs/omega2/examples/macrocycle.cpp>`



.. oe:source:: macrocycle.py
   :language: python
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`macrocycle.py <../../../../wrappers/python/examples/omega/macrocycle.py>`



.. oe:source:: Macrocycle.java
   :language: java
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Macrocycle.java <../../../../wrappers/java/examples/openeye/examples/oeomega/Macrocycle.java>`



.. oe:source:: Macrocycle.cs
   :language: csharp
   :caption:  Generating Macrocycle Conformers
   :refnum:   7

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`Macrocycle.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/Macrocycle.cs>`



.. _section_examples_single_conf_macrocycle:

Generating a Single Macrocycle Conformer
----------------------------------------

The following code example is a simple illustration of how to generate a
single macrocycle conformer using the OEMacrocycleBuilder object.

.. seealso::

   * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class
   * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class
   * :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class

.. oe:source:: single_conf_macrocycle.cpp
   :language: c++
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conf_macrocycle.cpp <../../../../sublibs/tklibs/omega2/examples/single_conf_macrocycle.cpp>`



.. oe:source:: single_conf_macrocycle.py
   :language: python
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`single_conf_macrocycle.py <../../../../wrappers/python/examples/omega/single_conf_macrocycle.py>`



.. oe:source:: SingleConformerMacrocycle.java
   :language: java
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformerMacrocycle.java <../../../../wrappers/java/examples/openeye/examples/oeomega/SingleConformerMacrocycle.java>`



.. oe:source:: SingleConformerMacrocycle.cs
   :language: csharp
   :caption:  Generating a Single Macrocycle Conformer
   :refnum:   8


.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SingleConformerMacrocycle.cs <../../../../wrappers/csharp/Csharp-Examples/OEOmega/SingleConformerMacrocycle.cs>`


