.. include:: ../toolkit-substitutions

.. _chapter_szmap_intro:

********************************************************************************
Introduction
********************************************************************************

The *Szmap TK* provides simple access to *SZMAP* functionality
for calculating solvent thermodynamic properties near molecular surfaces.


.. _section_licenses:

Licenses
================================================================================

To perform calculations with *Szmap TK* you will need to
obtain a license file for ``szmaptk`` and ``oechem``
from OpenEye, Cadence Molecular Sciences (https://www.eyesopen.com/contact).
If you wish to incorporate additional OpenEye functionality
into software you develop, other licenses may also be
required.

The license file
should be in a file pointed to by
the :envvar:`OE_LICENSE` environment variable.
On Windows, the environment variables can be set under the system
Control Panel.

This manual is to familiarize the user with *Szmap TK*
functionality. It does not provide an explanation
of basic *OEChem* classes and functions. Therefore reading the
*OEChem TK* manual beforehand is highly recommended.

Another source of information is the "OpenEye SZMAP" manual,
which describes the ``szmap`` and ``gameplan`` applications
and associated utilities, along with the theory behind *SZMAP*.

Finally, the "OpenEye Zap" manual is a good source of information
on the theory and practice of Poisson-Boltzmann calculations.


.. oe:language:: c++

   .. seealso::

      * :ref:`C++ Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_cpp_tk_import` section

.. oe:language:: python

   .. seealso::

      * :ref:`Python Quick Start Manual <section_python_getting_started>` for
        installation instructions.
      * :ref:`section_python_tk_import` section


.. oe:language:: java

   .. seealso::

      * :ref:`Java Quick Start Manual <section_cpp_getting_started>` for
        installation instructions.
      * :ref:`section_java_tk_import` section

.. oe:language:: csharp

   .. seealso::

      * :ref:`C# Quick Start Manual <section_csharp_getting_started>` for
        installation instructions.
      * :ref:`section_csharp_tk_import` section
