GCLAS

              Graphical Constituent Loading Analysis System

                     GCLAS - Version 2.4.1 2023/06/05


Instructions for installation and execution are provided below.
After installation, see the readme.txt file in the doc subdirectory of
the GCLAS installation directory for summary information on GCLAS.

For assistance, enhancement requests, or to report bugs, send e-mail to
gs-w_help_gclas@usgs.gov.


                          TABLE OF CONTENTS

                          A. SYSTEM REQUIREMENTS
                          B. DISTRIBUTION FILE
                          C. DOCUMENTATION
                          D. INSTALLING
                              o Installing GCLAS
                              o GCLAS directory structure
                          E. RUNNING THE PROGRAM
                          F. UNINSTALLING GCLAS
                          G. CONTACTS


A. SYSTEM REQUIREMENTS

A Java Runtime Environment (JRE) is required to install and run
GCLAS. Version 8 or higher is recommended. The latest open-source 
implementation of the JRE for Linux and Microsoft Windows platforms can 
be downloaded from https://adoptium.net. The GCLAS Linux start-up scripts 
are written in the Korn shell and so it must also be installed or the scripts
should be modified to use another scripting language.

B. DISTRIBUTION FILE

The following distribution package (containing the software and
information files) is currently available for UNIX systems:
  
  gclas_install_2_4_1.jar

C. DOCUMENTATION

A help manual can be displayed by selecting "Help Topics"
from the GCLAS Help menu. A user's manual can be is available on the
Web at http://pubs.usgs.gov/tm/2006/tm4C1/.

D. INSTALLING

The distribution file (gclas_install_2_4_1.jar) is a java installer. Type
"java -jar gclas_install_2_4_1.jar" to run it and then follow the instructions
given by the installer to complete the installation.

Thie installer creates the following directory structure (the contents of each
directory are shown to the right):

   gclas2.4.1                       files NOTICE.TXT and this README.TXT
     `-----bin                      script to run GCLAS
     `-----data                     example input data
     `-----config                   help and parameter definition files
     `-----dist                     GCLAS executable and required libraries
     `-----user                     potential working directory for user
     `-----resources                image files used by GCLAS
     `-----Uninstall                uninstaller for GCLAS

After GCLAS has been installed, it can be executed by typing the full pathname of
the execution script in the bin subdirectory, for example:

/usr/opt/wrdapp/gclas2.4.1/bin/gclas

However, to make the software accessible from any directory, create a link to the 
execution script, placing it in a directory that is included in each user's search 
path. For example, if each user's search path consists of

    /usr/bin:/usr/opt/bin:/usr/local/bin

using the command

    ln -s /usr/opt/wrdapp/gclas2.4.1/bin/gclas /usr/local/bin/gclas

will make the program accessible from any directory without requiring the
full pathname of the executable.  

Users with multiple JRE installations should note that the execution
script will execute the first java command found by the operating system
in searching the directories contained in the user's search path (type
"which java" to see which command this is; type "java -version" to see
what version of the JRE it is).  To execute a different java version,
uncomment and modify as appropriate the lines containing the JREHOME
variable in the execution script.

Note that the execution script is a Bash shell script. Unix users may need to
edit the script and change the first line from "#!/bin/bash" to "#!/bin/ksh".


E. RUNNING THE PROGRAM

If the program has been installed in a directory included in the users'
PATH (as described above), the program can be executed with the command
"gclas".  Otherwise, the full pathname of the execution script will need 
to be typed.

See the "GETTING STARTED" text in the upper right-hand panel of the
GCLAS window and the on-line help for assistance with using GCLAS.


F. UNINSTALLING GCLAS

To uninstall GCLAS, issue the command:

java -jar /usr/opt/wrdapp/gclas2.4.1/Uninstall/uninstall.jar

and follow the prompts. If GCLAS was not installed in the default location,
substitute the correct path to the Uninstall directory.

Be sure to remove any links created to the execution script as described under
INSTALLING above.


G. CONTACTS

Inquiries about this software distribution should be directed to:

gs-w_help_gclas@usgs.gov