|
RiverWare Release: 4.x
Last Updated: March 19, 2004
This document contains instructions for installing and setting up directories
and environment variables for RiverWare software on machines running the
Solaris operating system. You should have RiverWare downloaded to your
local system before you start reading this document. Refer to the document
RiverWare Viewer Download Guide
for how to download RiverWare software from the CADSWES FTP site or website.
Since the files (the files you downloaded from CADSWES FTP site or website)
are in a compressed format, you cannot install RiverWare by simply copying
the files to your directory, You must use the provided installation script.
You may contact CADSWES for technical support by:
Contents:
1.0 System Requirements
1.1 Hardware Requirements
1.2 Software Requirements
2.0 Recommended Directory for Installing RiverWare
3.0 RiverWare Installation Script
4.0 Instructions for Installing RiverWare
4.1 Installing the RiverWare Viewer
4.2 Installing CPLEX License
4.3 What to do if Installation
Fails
5.0 Executing RiverWare
5.1 Required RiverWare License
File
5.2 Optional UNIX Environment
Settings
5.3 Executing Instructions
- Sun SPARC station with Solaris 2.8, or greater, operating system.
- Installed RiverWare will occupy about 68 MB. Make sure you have a
file system with adequate disk space.
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/products/acrobat/readstep2.html.
Follow Adobe's installation instructions to install it on your system.
- CPLEX License
CPLEX is a third-party tool that RiverWare uses for linear programming
in Optimization. To run Optimization you must have a CPLEX license installed
on your system. CADSWES provides CPLEX license if you don't already have
it on your system. Contact CADSWES for CPLEX licensing information.
2.0 Recommended Directory for Installing RiverWare
Although it is not required, the following is the recommended directory
structure for installing RiverWare:
- Run the installation script from the directory where you have downloaded
the RiverWare, but specify your RiverWare base directory to be the installation
directory when you run the install script. By default, RiverWare will
be installed in the current directory, the directory where install script
is running.
- You may delete the downloaded files (for example, the files in the
directory "RiverWare-<release number>-<release type>")
if you wish after the new version is successfully installed.
- A completely installed RiverWare will have all of the RiverWare release
files residing in a single directory.
RiverWare installation script "riverware-install" is included
in each RiverWare release. It provides several selections to users, including
installing the RiverWare release, installing the CPLEX license, and the
help manual.
The installation script will guide you through all the steps. If you
are installing a new release to a directory where a version of RiverWare
has already installed, the install script also takes care of backing up
the current version of RiverWare and installing the new version of RiverWare.
All of the RiverWare files will be installed into the directory you have
selected. You may delete the downloaded files (for example, files in the
directory "RiverWare-<release number>-<release type>")
after the new version is successfully installed.
-
To start installing RiverWare, change your current directory to where
you have downloaded RiverWare. For example, if you have downloaded RiverWare
to directory /usr/local/RiverWare-4.0-rel,
$ cd /usr/local/RiverWare-4.0-rel
-
If you downloaded the release from CADSWES's website, you need to unpack
the downloaded tar file first,
$ tar xvf RiverWare-<release number>-<release
type>-solaris.tar
-
Start the installation script.
$ sh ./riverware-install
Enter your selection number at the main manual when prompted. When you
are asked to "Enter full path name of installation directory,"
enter your RiverWare base directory. For example, "/usr/local/RiverWare."
RiverWare release files are archived and compressed into several part???
files. A text file named "MANIFEST" which lists the contents
of the part??? files is required for installation. Run the installation
script "riverware-install" and select "RiverWare"
to install the files.
In summary, the steps it takes when installing the release are:
- Verifies the manifest file.
- Displays the version of RiverWare to be installed and asks if you
want to continue.
- Verifies the FTP or WEB transfer by verifying checksums of the pieces
of the split, compressed tar file.
- Backs up the current version of RiverWare (as a compressed tar file).
The backup file is created in the subdirectory "rwbackups"
and is named "riverware.<release-number>.tar.Z". The
number in the file represents the version number of the RiverWare. (No
backup will be performed if the executable file "riverware"
does not exist in the directory where you install the new RiverWare release.)
- Installs RiverWare.
- Verifies the checksums of the individual files.
4.2 Installing CPLEX License
Contact CADSWES for information.
4.3 What to do if Installation Fails
If the installation failed or was interrupted before it completed, You
need to re-run the installation script. Repeat the steps listed in
section 4.0.
5.0 Executing RiverWare
5.1 Required RiverWare License File
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 email system
as an attachment. Save the attached license file named "cadswes.lic"
to the subdirectory named "license" from where you have installed
RiverWare. The name of the file must be "cadswes.lic" and the
contents of the file must not be altered.
Also, if your license type is "Floating", you must start the
RiverWare license manager daemon before you can run RiverWare. Refer to
the document "RiverWare Viewer
License Manager User's Guide" for instructions of how to do this.
If your license type is "Node-locked", an active RiverWare license
manager daemon is not required. The type of your license is listed in
your "cadswes.lic" license file.
Following UNIX environment variables setting are optional.
Examples in this section assume you are running the C-shell; the exact
commands will vary for other shells. These are examples only; the location
of your libraries and other software may be different.
Each command example in this section starts with a command prompt "$"
which represents an Unix command.
- Add riverware to your search path so that the RiverWare you installed
can be run from anywhere.
$ set path=( . /usr/local/riverware $path)
- If you are running OpenWindows, the Xmgr plotting package may not
correctly find the X key system map. If this occurs, set the XKeysymDB
path.
$ setenv XKEYSYMDB /usr/openwin/lib/X11/XKeysymDB
- Set the RiverWare directory variable for writing temporary DMI files.
(Default to /tmp directory.)
$ setenv RIVERWARE_DMI_DIR /usr/local/models/tmp
- Set the RiverWare directory variable for writing Optimization output
files. (Default to /tmp/opt-username directory.)
$ setenv RIVERWARE_OPT_DIR $RIVERWARE_HOME/output
- Set the RiverWare default directory variable for the location of rules.
(Saves hunting the files when loading rules.)
$ setenv RIVERWARE_RULES_DIR /usr/local/models/rules
- The Adobe Acrobat Reader normally does not reside in the directory
where RiverWare was installed. One of the following must be done if Acrobat
Reader is not installed in the RiverWare home directory:
- Set environment variable "ACROREAD_PATH"
If Acrobat Reader is not installed in RiverWare home directory and
the path to the Acrobat Reader executable file "acroread"
is not in user's search path, set the default environment variable
for searching the Acrobat Reader executable file "acroread."
$ setenv ACROREAD_PATH /usr/local/adobe/acroread/bin
- Add "acroread" to user's search path
If Acrobat Reader is not installed in RiverWare home directory and
the environment variable ACROREAD_PATH is not set in user's environment,
add the full directory path to user's search path for searching the
Acrobat Reader executable file "acroread."
$ set path = ( $path /usr/local/adobe/acroread/bin )
Start RiverWare by entering the following command on the command line:
$ riverware
or
$ riverware &
(The "&" is optional and runs RiverWare in the background,
allowing the current window to remain active.)
If you are running OpenWindows, you should run RiverWare with the following
option parameters (which tells the GUI that the "look and feel"
should be "openlook"):
$ riverware -laf -ol
|
