readme.txt HUFPrint - Version: 1.2.2 5/17/2013 A Tabulation and Visualization Utility for the HUF Package of MODFLOW 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 HUFPrint is packaged for personal computers using Microsoft Windows 95, 98, ME, NT, 2000, XP, or 7. TABLE OF CONTENTS A. DISTRIBUTION FILE B. EXTRACTING FILES C. COMPILING D. INSTALLING E. RUNNING THE SOFTWARE F. TESTING G. REFERENCE A. DISTRIBUTION FILE The following self-extracting distribution file is for use on personal computers: HUFPrint_1_2_2.exe The distribution file contains: Compiled runfiles and source code for HUFPrint. Test data sets. B. EXTRACTING FILES The distribution file is a self-extracting program. Execution of the distribution file creates numerous individual files. The extraction program allows you to specify the directory in which the files should be restored. The installation instructions assume that the files are restored into directory C:\WRDAPP. The following directory structure will be created in C:\WRDAPP: | |--HUFprint | |--bin ; compiled executables. | |--doc ; documentation file(s) | |--src ; source code | |--test ; data and a batch file to run verification test | |--print ; output files generated by test case | It is recommended that no user files are kept in the HUFPrint directory structure. C. COMPILING Although a runfile (executable file) of the programs is provided, the source code is provided in the HUFPrint\src directory so that the program can be recompiled if necessary. However, no support can be provided for users generating their own versions of the software. In general, the requirements for compiling HUFPrint are a Fortran compiler and the knowledge of using the compiler. The Fortran source- code files (files ending in .f, .f90, or .inc) must be compiled with a Fortran (90 or 95) compiler. D. INSTALLING To make the executable versions of the programs accessible from any directory, the directory containing the executable (HUFPrint\bin) should be included in the PATH environment variable. Also, if a prior release of HUFPrint is installed on your system, the directory containing the executables for the prior release should be removed from the PATH environment variable. As an alternative, the executable file in the HUFPrint\bin directory can be copied into a directory already included in the PATH environment variable. How to add to the PATH environment variable On Windows9x and Windows ME systems, add the following line to the AUTOEXEC.BAT file: PATH=%PATH%;C:\WRDAPP\HUFPrint\bin Note, reboot your system after modifying AUTOEXEC.BAT. On 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\HUFprint\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\HUFPrint\bin" to its definition in the Value field, and click OK. Initiate and use a new MS-DOS Command Prompt window after making this change. On 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\HUFPrint\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 MS-DOS Command Prompt window. E. RUNNING THE SOFTWARE HUFPrint has been compiled using the Intel Fortran Compiler Integration for Microsoft Visual Studio .NET 2005, Version 11.1. The data arrays in HUFPrint are dynamically allocated, so models are not limited by hard-coded array limits. However, it is best to have enough random-access memory (RAM) available to hold all of the required data. If there is less available RAM than this, the program will use virtual memory, but this slows computations significantly. After the files in the HUFPrint\bin directory are installed in a directory that is included in your PATH, HUFPrint may be invoked in a DOS Command-Prompt window using the commands: HUFPrint [list-file] The name-file and command-file arguments are required; the list-file argument is optional. For name-file, provide the MODFLOW name file for the model to be analyzed by HUFPrint. For command-file, provide the name of the HUFPrint command file, as documented in Banta and Provost (2008). Use of the list-file argument is documented in the same report. If a fully double-precision version of MODFLOW was used to generate binary file(s) from which starting heads are to be read, use the double- precision version of HUFPrint (file HUFPrint_dp.exe). The command to invoke HUFPrint in this situation would be: HUFPrint_dp [list-file] F. TESTING A test data set is provided to verify that HUFPrint is correctly installed and running on the system. The directory HUFPrint\test contains the input data and expected results for each test. To test HUFPrint, create a new directory (for example, "MyTest") for the purpose of testing and copy the HUFPrint\test and HUFPrint\bin directories and their contents into the MyTest directory. Open a DOS command prompt window, and change directories to go to the MyTest\test directory. At the command prompt, execute batch file runtest.bat. Runtest.bat invokes HUFPrint with name-file specified as test.nam, command-file specified as test_commands.txt, and list-file specified as testoutput.hco. If HUFPrint is running correctly, two files (hufprint-list.txt and test_commands.txt.hco) will be recreated in the MyTest\test directory, and all files in the MyTest\test\print directory will be recreated. If HUFPrint is running correctly, the contents of these files will be the same as the corresponding files included in the HUFPrint distribution. G. REFERENCE Banta, E.R., and Provost, A.M., 2008, User guide for HUFPrint, a tabulation and visualization utility for the Hydrogeologic-Unit Flow (HUF) Package of MODFLOW: U.S. Geological Survey Techniques and Methods, 6-A27, 13 p. (available at http://water.usgs.gov/software/HUFPrint/)