CRT - Version: 1.3.1 Cascade Routing Tool NOTE: Any use of trade, product or firm names is for descriptive purposes only and does not imply endorsement by the U.S. Government. CRT version 1.3.1 is packaged for personal computers using one of the Microsoft Windows operating systems. This distribution includes a CRT version 1.3.1 executable file compiled for 64-bit operating systems, CRT_1.3.1.exe, as well as the source code. The cascade formulation was modified in version 1.3. Although CRT input is the same as previous versions, these changes potentially may result in differences in the number of cascade links and cascade link connectivity. Therefore CRT versions 1.3 and greater are not backwards compatible with previous versions of CRT. Version 1.3.1 is backwards compatible with version 1.3. The executables were compiled on a personal computer with the Intel(R) Core(TM) 2Duo CPU T9500 chipset, running the Microsoft Windows 10 operating system, using the Microsoft Visual Studio 2010 Version 14.0.24720.00 development environment and the Intel(R) Parallel Studio XE 2016 Fortran Compiler. The source code is provided to aid users in compilation on other computers. However, no support is provided for compilation. IMPORTANT: Users should review the file Summary_CRT.txt for a description of, and references for, this software. Users should also review the files release.txt and CRT_Updates.pdf, which describe changes that have been introduced into CRT with each official release; these changes may substantially affect users. Included with CRT is the Cascade Routing Visualization (CRV) ArcGIS Toolbox. CRV calls and executes the standalone CRT executable to generate the necessary vis.txt file. Alternatively, a valid vis.txt file can be provided by the user and imported as input for the CRV toolbox. CRV creates the cascade links feature class (CascadeFlow_XX) and cascade types feature class (CascadeType_XX) in a file-based geodatabase (CRV_XX.gdb), in a folder named CRV_XX, where XX is a number that identifies each subsequent execution of CRV. This toolbox is designed to be accessed using ArcGIS Desktop software (version 10.0 and above). This toolbox is built on top of standard functionality included in ArcGIS Desktop running at the ArcEditor license level. ArcGIS is a commercial GIS software system produced by ESRI, Inc. (http://www.esri.com). The CRV Toolbox is not supported by ESRI, Inc. or its technical support staff. Instructions for installation, execution, and testing of this version of CRT are provided below. TABLE OF CONTENTS A. DISTRIBUTION FILE B. INSTALLING CRT C. INSTALLING CRV ArcGIS Toolbox D. EXECUTING THE CRT SOFTWARE E. EXECUTING THE CRV ArcGIS Toolbox F. TESTING G. COMPILING A. DISTRIBUTION FILE The following distribution file is for use on personal computers: CRT_1.3.1.zip The distribution file contains: Executable and source code for CRT CRT documentation Cascade Routing Visualization ArcGIS Toolbox (CRV) Two CRT example applications The distribution file is a zip file for use on personal computers running Windows operating systems. The distribution file creates numerous individual files contained in the following directory structure: | |--CRT_1.3.1 | |--APPLICATIONS ; Input and output files for two CRT sample applications |--BIN ; Compiled CRT executable for personal computers |--CRV ; ArcGIS Toolbox and CRV installation instructions | |--Scratch ; Drive for storage of toolbox data |--Scripts ; Python scripts used to execute CRV |--Toolbox ; ArcGIS Toobox file |--ToolData ; Data for ArcGIS Toobox |--DOC ; CRT documentation |--SOURCE ; Source code for CRT Included in directory CRT_1.3.1\DOC is the CRT documentation report, which is a Portable Document Format (PDF) file. 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 site: http://www.adobe.com/ B. INSTALLING CRT 1. Download the CRT release from the USGS Software webpages (http://water.usgs.gov/software/lists/groundwater/). 2. Open the "CRT_1.3.1.zip" file and extract all CRT files to the selected installation directory. To make the executable version of CRT accessible from any directory, the directory containing the executable (CRT_1.3.1\BIN) should be included in the PATH environment variable. Also, if a prior release of CRT 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 files in the CRT_1.3.1\BIN directory can be copied into a directory already included in the PATH environment variable. The sample problems provided with the release (described below) have sample batch files that provide an alternative, additional approach for accessing the executable files. C. INSTALLING CRV ArcGIS Toolbox 1. Open the CRV Directory ("CRT_1.3.1\CRV"). This folder contains a collection of files and folders used for the CRV toolbox. 2. Start ArcMap or open an existing ArcMap document. It might be helpful to have a model grid and other data for the study area included for reference. GIS data sets for example applications are available as a separate file on the CRT software page http://water.usgs.gov/ogw/CRT/. Step-by-step instructions are provided below for adding the toolbox to ArcGIS 10.0. For more details and information about managing toolboxes within ArcGIS, see the ArcGIS online help article "Adding and Removing Toolboxes." 3. From ArcMap's main menu, select "Window -> ArcToolbox." to display the ArcToolbox window within ArcMap. 4. In the ArcToolbox window, right-click “Add Toolbox” from the context menu that appears. 5. Browse in the resulting dialog box to the folder that contains the CRV toolbox ("CRT_1.3.1\CRV\Toolbox") and select the file "CRV.tbx." 6. Click the "Open" button to add "CRV.tbx" to ArcMap. 7. Select the file “CRV.tbx” and click the “Open” Button. If the ArcMap document is saved, the reference to the CRV toolbox will be saved as well, and the toolbox will still be available when the current document is opened at a later time. Additionally, CRV can be made available in all ArcMap documents by right clicking in the ArcToolbox window and selecting “Save Settings” and choosing the “To Default” option. D. EXECUTING THE CRT SOFTWARE The CRT distribution has a 64-bit CRT Version 1.3.1 executable (CRT_1.3.1.exe) in the CRT_1.3.1\BIN directory. CRT can be executed by placing a CRT executable in the directory containing the input files and double clicking the file. Alternatively, the Windows batch file located in each application subdirectory (CRT.bat) can be used to run CRT Version 1.3.1 executable. CRT will provide output to the terminal window and to the outputstat.txt output file. The arrays in CRT are dynamically allocated, so models are not limited by the size of input data. However, it is best to have at least 4 MB of random-access memory (RAM) for CRT execution and more RAM for large models. If there is less available RAM than the model requires, which depends on the size of the application, the program will use virtual memory; however, this can slow execution significantly. If there is insufficient memory to run the model, then CRT will not initiate the beginning of the simulation; however, the Windows Command-Prompt window may continue to indicate that CRT is executing. For this circumstance, the program must be terminated manually using the Windows Task Manager application. CRT input and output files are all ASCII format and can be read or edited using any standard text editing software E. EXECUTING THE CRV ArcGIS Toolbox CRV can run CRT to compute cascades or use the user provided vis.txt file. The tools can be accessed the same way standard ArcGIS tools are used: by double- clicking on the name of the toolbox, or right clicking the toolbox to access its properties or documentation. 1. Expand “CRV.tbx” and double-click “CRV” script. 2. Enter in ‘User Workspace’ either (a) The folder location of CRT executable and all necessary input files for a CRT run or (b) The folder location of vis.txt from a successfully completed execution of CRT. Note that the ‘Visualization Only’ checkbox must be selected for this option. 3. The check box for ‘Visualization only’ signals that the CRT executable will not be run as a part of this visualization, and a valid vis.txt file is in the 'User Workspace'. 4. Specify the coordinate system; otherwise, the output-feature classes will inherit the coordinate system definition from the active data frame in the current ArcMap document: a) Click “Environments” button or go to the “Geoprocessing” menu and select “Environments” b) Expand “Output Coordinates” and specify a coordinate system c) Click “OK.” 5. Click “OK” to run CRV. CRV will display the CRT results in the current ArcMap document, where users can verify cascades. If cascades need to be modified, CRT input can be adjusted and CRV can re-execute CRT to recompute cascades. F. TESTING Two sample applications with CRT data sets are provided to verify that CRT is correctly installed and running on the system. The sample applications may also be looked at as examples of how to use the program. A description of the file structure for the example problem and of directions for running the example problem are described in the 'Readme.sagehen.txt' file located in directory CRT_1.3.1\APPLICATIONS\APPLICATION 1 SAGEHEN and the Readme.LWRB.txt file located in directory CRT_1.3.1\APPLICATIONS\APPLICATION 2 LWRB. (Note, users may want to download the supplemental GIS data for the two test problems separately from the CRT webpage). G. COMPILING The executable files provided in CRT_1.3.1\BIN were created using the Intel Visual Fortran compiler. Although executable versions of the program are provided, the source code also is provided in the CRT_1.3.1\SOURCE directory so that CRT can be recompiled if necessary. However, the USGS cannot provide assistance to those compiling CRT. In general, the requirements for compiling CRT are a Fortran compiler and the knowledge to use the compiler.