March, 2012
U. S. Geological Survey


                      MODPATH-LGR Version 1.0
              Distribution for IBM-PC compatible computers


NOTE: Any use of trade, product or firm names is for descriptive purposes 
      only and does not imply endorsement by the U.S. Government.

This version of MODFLOW-LGR is packaged for personal computers using one of
the Microsoft Windows operating systems. Executable files for personal 
computers are provided as well as the source code. The executables were compiled on a 
personal computer with the Intel(R) Core(TM)2Duo CPU E8400 chipset, running 
the Microsoft Windows XP operating system,using the Microsoft Visual Studio
2008 Version 9.0.21022.8 development environment and the Intel(R) Visual 
Fortran Version 11.1.054 compiler. The source code is provided to aid users in 
compilation on other computers. However, no support is provided for compilation.

Instructions for installing, executing, and testing MODPATH-LGR are provided below.


                             TABLE OF CONTENTS

                         A.  DISTRIBUTION FILE
                         B.  EXTRACTING FILES
                         C.  COMPILING
                         D.  INSTALLING
                         E.  RUNNING THE SOFTWARE
                         F.  TESTING


A. DISTRIBUTION FILE

The following self-extracting distribution file, containing the software,
test data sets, and information files, is currently available for
computer systems using one of the Microsoft Windows operating systems:

         mpathlgr1_0.exe


B. EXTRACTING FILES

Extract the files by executing file:

        mpathlgr1_0.exe

Extracting these files is all that is required for installation.
It is recommended that the directory structure in the zip file be 
maintained when the files are extracted.  The recommended installation
directory is C:\WRDAPP. When the extraction progrm runs, specify that
the files should be restored to directory C:\WRDAPP .  The following
directory structure will be created in C:\WRDAPP (the contents of each
directory are shown to the right):


   |
   |--mpathlgr.1_0
   |    |--bin       ; Compiled MODPATH-LGR and MODFLOW-LGR v. 1.2 executable for personal computers
   |    |--doc       ; Documentation files
   |    |--test      ; Input data to run verification tests
   |    |--src       ; MODFLOW-LGR source code for use on any computer

File mpathlgr.1_0/doc/tm6-a38.pdf is a Portable Document Format (PDF)
version of the MODPATH-LGR documentation. The PDF file is readable and 
printable on various computer platforms using Acrobat Reader from Adobe.  
The Acrobat Reader is freely available from the following World Wide Web sites:
      http://www.adobe.com/
      http://www.shareware.com/
      
      
C. COMPILING

The executable files provided in mpathlgr.1_0\bin were created using the Intel  
Visual Fortran 11.1.054 compiler. Although executable versions of the program are  
provided, the source code also is provided in the mpathlgr.1_0\src directory so 
that MODPATH-LGR can be recompiled if necessary. However, the USGS cannot provide  
assistance to those compiling MODPATH-LGR.


D: INSTALLING

To make the executable versions of MODPATH-LGR accessible from any
directory, the directory containing the executables (mpathlgr.1_0\bin)
should be included in the PATH environment variable (see explanation below).  

As an alternative, the executable file mplgr.exe in the mpathlgr.1_0\bin directory
can be copied into a directory already included in the PATH environment variable.

       HOW TO ADD TO THE PATH ENVIRONMENT VARIABLE
          WINDOWS 9 X AND WINDOWS ME SYSTEMS
          
Add the following line to the AUTOEXEC.BAT file:

  PATH=%PATH%;C:\WRDAPP\mpathlgr.1_0\bin

Note, reboot your system after modifying AUTOEXEC.BAT.


       HOW TO ADD TO THE PATH ENVIRONMENT VARIABLE
               WINDOWS NT SYSTEMS

From the Start menu, select Settings and then Control Panel.  Double click
System and select the Environment tab. To add a new user variable, enter
"PATH" in the Variable field and enter

   %PATH%;C:\WRDAPP\mpathlgr.1_0\bin

in the Value field.  Click Set and then click OK.  If a PATH user variable
already is defined, click on it in the User Variables pane, add
";C:\WRDAPP\mpathlgr.1_0\bin" to its definition in the Value field, and click
OK.  Initiate and use a new Windows Command Prompt window after making this
change.


       HOW TO ADD TO THE PATH ENVIRONMENT VARIABLE
             WINDOWS 2000 OR XP SYSTEMS
             
From the Start menu, select Settings and then Control Panel.  Double click
System and select the Advanced tab.  Click on Environment Variables.  If
a PATH user variable already is defined, click on it in the User Variables
pane, then click Edit.  In the Edit User Variable window, add
";C:\WRDAPP\mpathlgr.1_0\bin" to the end of the Variable Value (ensure that
the current contents of the User Value are not deleted) and click OK.  If
a PATH user variable is not already defined, in the User variables pane of
the Environment Variables window, click New.  In the New User Variable
window, define a new variable PATH as shown above.  Click OK.  Click OK
in the Environment Variables window and again in the System Properties
window.  Initiate and use a new Windows Command Prompt window.


E. EXECUTING THE SOFTWARE

After MODPATH-LGR is properly installed in a directory
that is included in the user's search path, it can be executed using either of 
the commands: 

		mplgr.exe

or

		mplgr.exe [MODPATH-LGR control file]

or

		mplgr.exe [MODPATH response file]

Some of the files written by MODPATH-LGR may be specified by the user to be 
unformatted files. The structure of these files depends on the compiler and 
options in the Fortran write statement.  MODPATH-LGR is compiled with the 
unformatted file type specified as "BINARY". Any program that reads the 
unformatted files produced by MODPATH-LGR must be compiled with a compiler 
that produces programs that use the same structure for unformatted files.


F. TESTING

Directory C:\WRDAPP\mpathlgr.1_0\test has data files for running the example
problems described in the MODPATH-LGR documentation.  Run these problems as
follows:

1. The MODFLOW and MODFLOW-LGR input files needed to run the MODPATH-LGR example 
   problems are already present in the mpathlgr.1_0\test\example1 and 
   mpathlgr.1_0\test\example2 directories. To run the tests, MODFLOW-LGR needs 
   to be exectuted for the MODFLOW models to generate the output files for the 
	 example problems used by MODPATH-LGR. Note that MODPATH-LGR version 1.2.00 or  
	 later is required to generate the outputs needed by MODPATH-LGR. An executable
	 of MODFLOW-LGR version 1.2.00 is included in the directory mpathlgr.1_0\src.
	 
2. Once the MODFLOW-LGR output files have been generated, you can now run the 
   MODPATH-LGR example problems. The example problems are the same problems
   presented in the MODPATH-LGR manual (USGS Techniques and Methods 6-A38). 

   MODPATH-LGR uses either a combination of interactive and data file
   input. If MODPATH-LGR is used to track particles through a single model,
   the user can provide input by using either a MODPATH response file
   (described by Pollock, 1994) or interactive input. If MODPATH-LGR is 
   used to track particles through multiple models, then a MODPATH-LGR control
   file is required. A MODPATH-LGR control file is provided in the directories
   for each example problem.
   
   Global output files generated by MODPATH-LGR can be plotted by using the
   software MODPATH-PLOT, which is distributed with the original MODPATH program
   by Pollock (1994). Please see the MODPATH manual (USGS Open File Report 94-464)
   for instructions on running MODPATH or MODPATH-PLOT.