.. _szmap_examples_szmapenergies:

Analyze binding site energies
================================================================================

A program that calculates energies at each ligand atom coordinate.

.. seealso::

   * :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` class
   * :ref:`OESzmapResults <OESzmap_OESzmapResults>` class
   * :oe:func:`OESzmap::OECalcSzmapValue` function
   * :oe:func:`OESzmap::OEIsClashing` function
   * :oe:constns:`OESzmap::OEEnsemble` namespace


Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      SzmapEnergies --help

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapEnergies.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapEnergies --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapEnergies --help


will generate the following output:

.. code-block:: console

   Simple parameter list
    -high_res : If true, increase the number of orientations to 360
    -l : Input ligand coordinates for calculations
    -p : Input protein (or other) context mol


Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.cpp <../../../../sublibs/tklibs/szmap/examples/SzmapEnergies.cpp>`


   .. only:: oepdf

      .. oe:source:: SzmapEnergies.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.py <../../../../wrappers/python/examples/szmap/SzmapEnergies.py>`


   .. :ref:`Full listing. <listing-SzmapEnergies.py>`

   ..   literalinclude:: ../../../../wrappers/python/examples/szmap/SzmapEnergies.py

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.java <../../../../wrappers/java/examples/openeye/examples/oeszmap/SzmapEnergies.java>`

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapEnergies.cs <../../../../wrappers/csharp/Csharp-Examples/OESzmap/SzmapEnergies.cs>`

   .. only:: oepdf

      .. oe:source:: SzmapEnergies.cs
         :language: csharp

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapEnergies.py -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapEnergies -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz
