CADSWES
  Home  >  RiverWare  >  Viewer  >  Windows Installation Guide
RiverWare Viewer Installation Guide
Windows Platform
 

RiverWare Release: 4.x
Last Updated: February 23, 2007

This document contains the information for system requirements, instructions for installing and uninstalling RiverWare software, and environment set up, on machines running the Windows NT/2000/XP operating system. Refer to the document RiverWare Viewer Download Guide for how to download RiverWare from the CADSWES FTP site or website.

You may contact CADSWES for technical support by:

Contents:

1.0 System Requirements
1.1 Hardware Requirements
1.2 Software Requirements

2.0 Instructions for Installing the RiverWare Viewer
    2.1 RiverWare Install File and Setup Instructions
    2.2 RiverWare License File and Setup Instructions
    2.3 Installing Adobe Acrobat Reader Files
    2.4 Installing CPLEX License
    2.5 Installing ExcelWriter
    2.6 Installing GPAT
    2.7 What to do if Installation Fails

3.0 Instructions for Uninstalling RiverWare

4.0 Executing RiverWare
    4.1 Required RiverWare License File
    4.2 Required Windows Environment Settings
    4.3 Executing Instructions


1.0 System Requirements

1.1 Hardware Requirements

Following is the minimum system requirements for running the Windows version of RiverWare:

  • Windows 2000 operating system, Windows NT 4.0 (Intel) operating system with Service Pack 6 installed, or Windows XP operating system
  • Intel Pentium/Celeron family or compatible processor PC with 300 MHz or higher recommended
  • 256 megabytes (MB) of RAM or higher recommended (Many of the RiverWare users have more than 1 GB of memory.)
  • Disk space: (does not include space for model files)

  • 17 MB for RiverWare install file "rw??setup.exe" (or rw???setup.exe) before the installation
    24 MB for all of the RiverWare files after the installation
  • Super VGA (800 x 600) or higher-resolution video adapter and monitor
  • keyboard and mouse or compatible pointing device

1.2 Software Requirements

A completely installed RiverWare will have all of the RiverWare files residing in a single directory. Each RiverWare release is a full release, which means each release contains all the files required to run RiverWare, with the exception of the following:

  • RiverWare license file "cadswes.lic"
     
  • Adobe Acrobat Reader

  • Adobe Acrobat Reader is required for viewing RiverWare online help files since those files are written in PDF format. It is available for downloading from Adobe's website for free at www.adobe.com/porducts/acrobat/readstep2.html . Follow Adobe's installation instructions to install it on your system.
     
  • CPLEX license
    CPLEX is a third-party tool RiverWare uses for linear programming in Optimization. To run Optimization you must have a CPLEX license installed on your system. CADSWES provides a CPLEX license if you don't already have it on your system. Contact CADSWES for CPLEX licensing information.

2.0 Instructions for Installing the RiverWare Viewer

2.1 RiverWare Install File and Setup Instructions

Each RiverWare install file is named rw??setup.exe or rw???setup.exe. The ?? represents a major release number, and ??? represents a patch release number. For example, rw40setup.exe is the install program for release 4.0, rw402setup.exe is the install program for patch release 4.0.2.

When you start downloading a RiverWare release from CADSWES's website, you will be given an option of start the installation process right after the download or save it to your filesystem and install later.

RiverWare install file is in a compressed format. Each RiverWare install file contains a full release of RiverWare, which means it contains all the files you need to run RiverWare (except the required RiverWare license file "cadswes.lic," the Adobe Acrobat Reader files for viewing RiverWare online help files, and CPLEX license file).

You also need "administrator" user privileges to install RiverWare on your system.

To install RiverWare on a Windows 2000 machine:

  • On the machine which RiverWare will be installed, log on as a user with administrator privileges.
     
  • If you already have a copy of downloaded install file on your filesystem (that you downloaded from CADSWES FTP site or website), locate the RiverWare install program "rw??setup.exe" (or rw???setup.exe) you want to install from Windows Explorer. Double-click on the file to initiate the install process.

    Or you can log on to RiverWare Web Download page and click on the release that you want to download and install. You will have a choice of starting the install process immediately, which means the install file will download, extract itself, and begin the installation; or saving the file to your filesystem, which means you have to find and execute the downloaded install file later to initiate the install process.

  • If the install program detects an identical version of RiverWare release exists on the machine, you will get a Setup Maintenance Program window. Select "Remove - Remove currently installed RiverWare" to uninstall the previously installed RiverWare on the machine. Then re-run the RiverWare install program to install the release.
     
  • The installation program will guide you through all the steps. A completely installed RiverWare will have all of the RiverWare files residing in a single directory.
     
  • If you are running the install program directly from a CD, you may be asked if you want to re-start your computer at the end of the installation process. You DO NOT need to reboot your computer to start RiverWare.
     
  • A RiverWare icon is placed on the desktop after the installation. It is also added to the CADSWES folder in the Windows Start Programs menu.

2.2 RiverWare License File and Setup Instructions

Before running RiverWare, you must obtain a RiverWare license file named "cadswes.lic" from CADSWES. RiverWare license file is a text file and normally CADSWES delivers this file to you through the email system as an attachment.

Also, depending on your license type, you may need to start the RiverWare license manager daemon before you can run RiverWare. If your license type is "Floating license," you need to start the RiverWare license manager daemon before you can run RiverWare. Refer to the document "RiverWare License Manager User's Guide" for instructions of how to do this. If your license type is "Node-locked license," an active RiverWare license manager daemon is not required. The type of your license is listed in your "cadswes.lic" license file.

To install your RiverWare license file:

  • Save your RiverWare license file "cadswes.lic" to the same directory where you have installed RiverWare. This file must be saved as a text file and must be named "cadswes.lic." Please do not make any changes to the saved "cadswes.lic" file.

2.3 Installing Adobe Acrobat Reader Files

Adobe Acrobat Reader is available for downloading from Adobe's website. The URL is www.adobe.com/products/acrobat/readstep2.html. To install it on your system, follow Adobe's installation instructions.

2.4 Installing CPLEX License

Please contact CADSWES for information.

2.5 Installing ExcelWriter

ExcelWriter is an MS Windows-only application. Just download the xlwriter.exe file to your Windows machine. There is no install program for ExcelWriter. All you need to do to run the program is to find the xlwriter.exe file in Windows Explorer or File Manager and double-click it.

Running ExcelWriter in Windows 3.11:

ExcelWriter can be used with Windows 3.11. If you do plan to use it with Windows 3.11, then you must have the Win32s drivers installed. These drivers are distributed by Microsoft so that Windows 3.11 that can run 32-bit programs. ExcelWriter takes advantage of the Windows 32-bit capabilities, so it is imperative that these drivers be installed on your Windows 3.11 system.

The Win32s drivers are available from the CADSWES FTP site. Download the file "Pw1118.exe" and create a directory to store this file in. Run the file by double clicking on it. It will extract a number of files into the directory in which it sits, so you do not want to run it from the root directory or any directory that you do not want cluttered up. From there, run the SETUP.EXE file that is extracted; then you should be set up with Win32s and be able to run ExcelWriter.

2.6 Installing GPAT

GPAT is an MS Windows-only application. You must move the downloaded file "GPAT.zip" to a machine running Windows95, NT, 2000, Me, etc.

The GPAT.zip file is a compressed file containing these files:

  • Graphical Policy Analysis Tool 1.1.xla - Microsoft Excel Add-In Program
  • Getting Started With GPAT.doc - Introduction Documentation
  • Gpat.hlp - Help Files

You will need to decompress the file using "pkunzip" found at www.pkware.com or WinZip found at www.winzip.com.

On a Windows machine, run the command "pkunzip" or use the WinZip utility to unzip the "GPAT.zip" file. For example:

C:\ pkunzip GPAT.zip

There is no install program for GPAT. All you need to do is run GPAT from Microsoft Excel and open it as an add in. Once you are in the Excel environment, select the "Tools" pull down menu and choose "Add-ins." From the Add-Ins window, select "Browse" and find the file titled "Graphical Policy Analysis Tool 1.1.xla"

To use the help menu, either directly open the Gpat.hlp file from Windows Explorer, or browse for it from within the GPAT interface.

2.7 What to do if Installation Fails

If the installation failed or was interrupted before it completed, you need to repeat the steps listed in section 2.0. Or contact CADSWES Support for assistance.

3.0 Instructions for Uninstalling the RiverWare Viewer

It is not recommended that you uninstall RiverWare by deleting the installed RiverWare files directly from the filesystem. We recommend the following procedure for deleting RiverWare from your system:

  • From your desktop, select Start -> Settings -> Control Panel -> Add/Remove Programs.
     
  • From the Add/Remove Programs Properties window, select the version of the RiverWare you want to remove.
     
  • Click on the Change/Remove button.
     
  • From the InstallShield Wizard window, click on "Remove" button and then click on "Next" button.

4.0 Executing RiverWare

4.1 Required RiverWare License File

The first time you start RiverWare, you need to log on as user "administrator." Because the location of the RiverWare license file will be recorded into the registry on your system. This allows all other users to run RiverWare installed on your machine. See section 4.3, Executing Instructions for instructions on how to set the license file.

When the location of the RiverWare license file is successfully recorded in the registry on your system, users will not get the dialog asking for RiverWare license file anymore when they start RiverWare.

4.2 Required Windows Environment Settings

After RiverWare is successfully installed on your system, following environment variables are required in order to run RiverWare and access the RiverWare online help files.

Following are directions for setting the environment variables on a Windows 2000 machine:

  • RIVERWARE_HOME

    During the installation process, this variable is set by default to the full directory path where you have installed RiverWare. Normally you do not need to set this manually.

  • ACROREAD_PATH

    The Adobe Acrobat Reader (or Adobe Acrobat) is required for viewing RiverWare online help files. This variable needs to be set to the full directory path where the Adobe Acrobat executable file resides on your system. It should be set as a system environment variable by a user with administrator privileges immediately after RiverWare has been installed.

    • Select Start -> Settings -> Control Panel -> System.
       
    • From the System Properties window, select Advanced folder.
       
    • Click on "Environment Variables..." button.
       
    • Click on "New" in System Variables.
       
    • In the System Variable dialog, enter ACROREAD_PATH for Variable Name, enter the full directory path where the Acrobat Reader executable file (or Acrobat executable file) resides for Variable Value. You must specified the executable name, not just the directory path. For example,

      If you have Adobe Acrobat installed on your system, enter:

      C:\Program Files\Adobe\Acrobat 4.0\acrobat\acrobat.exe

      If you have Adobe Acrobat Reader installed on your system, enter:

      C:\Program Files\Adobe\Acrobat 4.0\Acroread\acrord32.exe
    • Click on OK. Click on OK to close the Environment Variables window. Click on OK to close the System Properties window.

4.3 Executing Instructions

Start RiverWare for the first time on the machine:

When you are starting RiverWare for the first time after it has been installed, you will be asked to enter the RiverWare license file location. This information will be recorded into the system registry when it is successfully obtained. Then, no user will be asked again for the license information when starting RiverWare on this machine.

You need to log on to the machine with the system administrative privileges in order to recored the license file location into the system registry. You also need to have your RiverWare license file "cadswes.lic" ready.

If your license type is Node-Locked license:

  • Start RiverWare.
     
  • From the "FLEXlm License Finder" window, choose the "Specify the License File" option and then click on the "Next" button.
     
  • Use the browse button to select your "cadswes.lic" file and then click on the "Next" button.
     
  • Click on the "Finish" button.
     
  • RiverWare application will start running when the license file is successfully located.
     
  • If RiverWare encounters any problems when trying to access a license file, a window will show up and display an error message. Please save the error messages and email it to CADSWES support for debugging.

If your license type is Floating license:

  • RiverWare license daemons must be active on the server in order to run RiverWare using a floating license. Refer to "RiverWare License Manager User's Guide" for instructions of configuring and starting the RiverWare license servers on your machine.
     
  • With RiverWare license server active, start RiverWare.
     
  • From the "FLEXlm License Finder" window, choose the "Specify the License Server" option and then click on the "Next" button.
     
  • Enger the machine name that is running the RiverWare license server in the following format:
    @machine-name

    For example, if the machine name is "venus," then enter "@venus."

  • Click on the "Finish" button.
     
  • RiverWare application will start running when the license file is successfully located.

Follow the instructions below to start RiverWare:

  • To start RiverWare, execute "riverware.exe" file. A RiverWare icon is placed on the desktop after the installation. It is also available from the Windows Start -> Programs -> CADSWES menu.
     
  • When the license file is successfully located, RiverWare application will start running.
 

CADSWES - Center for Advanced Decision Support for Water and Environmental Systems
cadswes.colorado.edu -- edit February 23, 2007 -- e-mail webmaster