=================
Running poly2dRpt
=================

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


-----------------------
Ways to Run this Script
-----------------------

This script can be run from MineSight(r) or from the command line. It
can be run with or without a GUI interface.    
    
If run from MineSight(R) or from the command line with no arguments, a
GUI is presented. If run from MineSight(R), no arguments are allowed, so
the GUI panel is always presented.

To run silent without the GUI, an .ini file can be used that contains
configuration values describing what is wanted in the report. Starting
the script with command line arguments as explained below suppress the
GUI interface panel and the values .ini file are used. 

To create an .ini file, run the script with no   arguments and enter
your desired configuration into the GUI panel and check "Save
Responses".  This will create an .ini file in your project directory, if
run from MineSight(R) or the working directory, if run from the command
line.

Multiple .ini files can be created, one for each project as they can be
stored in the respective project directories.

The .ini file is always named :file:`<script name>.ini` (for example
file:`poly2dRpt.ini`).

----------------
Script Arguments
----------------

::

    Usage: <scriptName>.py ['' | 0 | 1 | 2 | -h]

         where

            ''|0   Present graphical user interface
                   panel using values retrieved
                   from .ini file, if any, to
                   populate initial panel.
                   If no .ini file or values are bad,
                   reset with default internal values
                   before presenting panel.
                   (default mode from MineSight(R))

            1      Run silent: Use .ini values exclusively.
                   Do not present gui. Fail if bad .ini values.

            2      Run Silent: Use default(internal)
                   values if no .ini/bad .ini values."
                   Do not present gui. Fail if bad
                   internal config values.

            -h     Print help about this script