=================================
``grail.info`` Module
=================================
.. include:: ..\version.h
.. include:: ..\Library_Reference\lib-reference.h

.. contents:: Table of Contents
   :backlinks: top

--------
Overview
--------

Provides information about the MineSight(r) Grail (MSGRAIL) environment. One of
the most useful defined values for this module is the :d:`DESCRIPTION`
string. The :d:`DESCRIPTION` string provides a quick snapshot of
MSGRAIL for display.

An example of using the :d:`DESCRIPTION` would be as simple as,

  .. Python::

    import grail.info
    print grail.info.DESCRIPTION

and you would get a result similar too,

  ::

    Grail Directory: C:\ian\dev\mtlvc\gsrc\grail
      Grail Version: 3.70 (DEV) (Build 469)
           Compiler: MSC VC6 (32 Bit)
         Python API: 2.2.3

where the actual result may vary from release to release.

----
Data
----

The following constants are available via this module,

:d:`COMPILER_INFO`
    A string with the contents of the compiler used to build MSGRAIL
    extensions.

:d:`DESCRIPTION`
    A multi-line description string useful for quickly displaying
    information about MSGRAIL.

:d:`GRAIL_DIR`
    The directory that MSGRAIL is within.

:d:`IS_DEBUG`
    Whether or not the build was done in DEBUG mode.

:d:`IS_IN_MS3D`
    Returns wheter or not the script is being executed within MS3D (Embedded) or
    via the command line, and outside of MS3D.

:d:`VERSION_BUILD`
    The version build number.

:d:`VERSION_BUILD_DATE`
    The version build date as a string.

:d:`VERSION_BUILD_STR`
    The version build number as a string.

:d:`VERSION_FULL_STR`
    The full version string, used in the :d:`DESCRIPTION`.

:d:`VERSION_MAJOR`
    The major release number.

:d:`VERSION_MAJOR_STR`
    The major release number as a string.

:d:`VERSION_MINOR`
    The minor release number.

:d:`VERSION_MINOR_STR`
    The minor release number as a string.

:d:`VERSION_PATCH`
    The patch number.

:d:`VERSION_PATCH_STR`
    The patch number as a string.

:d:`VERSION_STR`
    The reduced version string (no build information)