Installation Procedures


Before you install SansGUI, please check System Requirements.

SansGUI is distributed primarily on a single read-only compact disc (CD-ROM). If your system has AutoRun enabled for CD/DVDs, you can simply put the SansGUI CD-ROM into your CD or DVD player and the installation program will run automatically; otherwise, use Windows Explorer to find the Setup program on the top level of the CD-ROM and execute it by double clicking on the Setup icon.

During the installation process, you will be asked to do the following:

Starting SansGUI

During the installation procedures, a SansGUI program icon is created on your Windows desktop and a program folder is created under the Start>Programs menu. You can start SansGUI by selecting the SansGUI item in the program folder, or simply double clicking on the SansGUI desktop icon.

License Keys

The license key copied to your installation directory is only temporary. It is for demonstration purposes only. To finish up your installation, you will need to obtain a permanent key from ProtoDesign, Inc. See Permanent License Key for more detail.

Directory Structure

If you use the default directory location to install SansGUI, the distribution files will be copied under the \SansGUI\vVersionNumber directory where VersionNumber refers to the version of SansGUI that you have just installed. It follows a convention in that version 1.2 will be 1_2. Thus, the default SansGUI installation directory for version 1.2 is \SansGUI\v1_2. It is recommended that you keep this directory naming convention so that different versions of SansGUI can be installed in different directories. This helps when multiple versions of SansGUI need to co-exist. SansGUI versions are identified by a major and a minor release numbers. Patches will be used for bug fixes and minor enhancements and will be copied over the existing installations.

 

In the installation directory, you will find:

File

Description

License.txt

a copy of SansGUI License Agreement

Release.txt

the release notes of the specific SansGUI version

Patch.n

notes related to a specific patch level n applied to the release

 

Under the SansGUI installation directory, you will find the following subdirectories:

Directory

Description

bin

for SansGUI executable files and on-line WinHelp files

doc

for simulation developers to install their on-line documentation

doc\SansGUI

for SansGUI on-line documentation in plain HTML

lib

for simulation developers to install Object Libraries (.sgo files)

sim

for simulation developers to install Simulators and custom invocation scripts in DLL, EXE, or other executable formats

inc

for header and source files used to create simulator executables and user overrides

img

for blank icons to be used by simulation developers as a starting point

key

for SansGUI license key files

sys

for system files, from Microsoft or other 3rd parties

samples

for demonstration projects showing the basic uses of SansGUI

 

Optional Environment Variables

In most cases, you do not need to define any extra environment variables to use SansGUI. This is because by default it uses the directories relative to your installation directory to find its necessary files. However, there may be some situations where custom file locations are desired. For these situations, the following environment variables can be used:

Variable

Usage

SGUI_KEY

License key file should be at a different location. For example, if SansGUI is installed on a server, the key locations for different clients should be defined individually.

SGUI_LIB

Object Libraries of Simulators are stored in a non-default directory

SGUI_SIM

Simulator executables are stored in a non-default directory

SGUI_DOC

Simulator documentation files are stored in a non-default directory

Windows NT

Go to the Start menu and select Start>Settings>Control Panel. In the Control Panel, double click on the System icon. A System Properties dialog will pop up. Click on the Environment tab to define the desired environment variables. Enter the variable names in the Variable field and the "new" directory in the Value field. Click on the Set button to commit to the new definition. You will need to log off and back on again to make the new definitions effective.

Windows 2000

The procedure is similar to that of Windows NT except that the environment variables are accessed through the Advanced tab and then via the Environment Variables... button in the System Properties dialog.

Another way of changing the environment variables is to modify the AUTOEXEC.BAT file as in Windows 95/98 shown below. It is, however, not recommended for Windows NT or Windows 2000.

Windows 95 or 98

You can define these environment variables in the AUTOEXEC.BAT file. Define them by using the SET command. For example, to redirect the license key directory to C:\MyKeys, enter the next line in the AUTOEXEC.BAT file:

SET SGUI_KEY=C:\MyKeys

You will need to shutdown and restart the computer for the new definitions to take effect.

When SansGUI is up and running, you can go to Help>File Locations... menu item to verify your configuration settings.

Special Issues for Windows 95

Normally, you don't need to use the two following programs during the installation. However, if your system is running the first edition of Windows 95, you may need to run either or both of the programs to update your system manually.

There are two executable files (.EXE) stored under sys\ subdirectory:

System Files

The SansGUI installation procedure checks the following MS Visual C++ 6.0 (SP3) files on your system directory and modifies the files when they are of earlier versions or of earlier dates:

File

Description

MFC42.DLL

Microsoft Foundation Class core code (MBCS enabled)

MSVCRT.DLL

Shared DLL version of C Run-Time

OLEAUT32.DLL

Central automation DLL

 

Windows Registry

SansGUI uses registry settings under:

My Computer

     HKEY_CURRENT_USER

           Software

                 ProtoDesign, Inc.

                       SansGUI

Fine Tuning Your Installation

Depending on the physical memory size and screen resolution of your system, you may want to fine tune some parameters found in the Options... dialog under the Tools menu. To do this, you will need to have a file (of any type, Schema Definition, Object Library, or Project Model) opened. For more details about these parameters, please consult Customizing SansGUI Environment in the User's Guide.

Uninstalling SansGUI

To uninstall SansGUI, run Add/Remove Programs from the Windows' Control Panel and follow the directions during the uninstall procedure. If you have created any files beyond the original SansGUI distributed files, they will not be removed and the directories containing them will be kept.

3rd-Party Simulators

The standard locations of 3rd-party Simulators written for SansGUI can be found under SansGUI installation subdirectories:

Directory

Description

lib

for Simulator's Object Libraries created from the SansGUI Development Environment

sim

for Simulator's executables, DLLs and/or external process programs

doc

for Simulator's on-line documentation

 

These locations are default locations. The users can customize them by defining environment variables SGUI_LIB, SGUI_SIM, and SGUI_DOC, respectively. See Optional Environment Variables section above.

 



C:\FH_Suite\htmlgifs\home.gif System Requirements Permanent License Key

SansGUI Modeling and Simulation Environment Version 1.2

Copyright 2000-2003 ProtoDesign, Inc. All rights reserved.

http://protodesign-inc.com