Chapter 2: Installing HyperWorks
2.5 Setting Up HyperWorks Help
The HyperWorks help system is a browser-based HTML help system. It can be installed with applications or installed alone on a server. This section describes how to set up and access HyperWorks help system.
Help systems for AcuSolve, SimLab, solidThinking Inspire and Evolve, and Virtual Wind Tunnel are always installed on the local machine with applications.
2.5a Set up HyperWorks Help
The HyperWorks help system can be installed with applications or installed alone on a server. In order for the help to work properly from applications, you must set up a valid Internet browser and a valid path to the HyperWorks help installation if help is not installed with the application. Help can be installed via different ways:
• On a local machine along with the HyperWorks software
• Pre-installed on a shared network location
• Use Altair Website help.
In order for HyperWorks help to work properly, you must set up a valid browser on the machine from which the application is launched. For Windows and Mac, HyperWorks uses the default Windows (or Mac) browser. For Unix and Linux, the valid browser is set during the installation time. You can verify the browser setting stored in the hwhelp.cfg file. The hwhelp.cfg file is located in the
<installation directory>/altair/ directory on Linux/Mac, and the top-level installation directory on Windows.
If Help is pre-installed on a shared network location, the information will be stored in the hwhelp.cfg file as well. A typical hwhelp.cfg file should contain the following information:
HW_MSG_BROWSER /usr/bin/firefox
HW_MSG_HELP <install_dir>/altair/help
If HW_MSG_HELP is not set in the hwhelp.cfg file, HyperWorks application will connect to the Altair web site help automatically.
The help server on UNIX platforms does not support tilde (~) completion of paths.Please make sure that you use the full path for the items HW_MSG_HELP and HW_MSG_BROWSER if you set them as environment variables or in hwhelp.cfg. (for example, use /path/to/help_user/my_help instead of ~help_user/my_help).
2.5b Start Help from the Application Help Menu
The steps to start help from application Help menu are similar for most applications.
1. Set up the browser and help environment before starting the application as described above.
2. Start the application.
3. Click the Help drop-down list and choose the help for the selected application.
Once the online help has been launched, you can use the Index, Contents, or Search to locate the help for a specific topic. The context sensitive help works as well.
2.5c Start Help from the altair/scripts Directory (Linux Only)
Each HyperWorks Help book can be invoked via command prompt by pointing to the altair/scripts/help script.
2.5d Help Installed on Server Type (Windows Only)
If you have chosen Server setup type described in Section 2.1, each client is installed through NETSETUP as described in Section 2.2. HyperWorks applications will be available from the Start menu. If both the HyperWorks application and help are installed on the software server, help can be accessed on this client as long as a valid browser is installed on the client machine.
Appendix A: Setting Up the CAD Translators
UG Environment Variable Settings
Since the UG reader needs to use the UGOpen library during the run time, it requires that a valid UG installation and UG license1 be present and available to the user with the assemblies, gateway and solid_modeling modules.
The UG installation must be the same bit-level and platform as the version of HyperMesh (thus, 64-bit HyperMesh must be used with 64-bit UG). It is not possible to mix 32-bit and 64-bit versions.
The following environment variables must be set prior to starting:
Windows:
UGII_BASE_DIR This must point to the UG installation directory2. UGII_ROOT_DIR This must point to the UG installation UGII directory2. PATH This must include the %UGII_BASE_DIR%\UGII\ directory.3 SPLM_LICENSE_SERVER
UGS_LICENSE_SERVER
This must point to the UG license server1.
UGS_LICENSE_BUNDLE This must specify the UG license bundle1.
Example: UG installation located at C:\Program Files\UGS\NX 6.0 UGII_BASE_DIR: C:\Program Files\UGS\NX 6.0
UGII_BASE_DIR This must point to the UG installation directory2. UGII_ROOT_DIR This must point to the UG installation bin directory2. SPLM_LICENSE_SERVER This must point to the UG license server1.
UGS_LICENSE_SERVER
UGS_LICENSE_BUNDLE This must specify the UG license bundle1.
Example: UG installation located at /soft/usr/ugs060 UGII_BASE_DIR: /soft/usr/ugs060
UGII_ROOT_DIR: /soft/usr/ugs060/bin/
UGS_LICENSE_SERVER: 28000@licsrv UGS_LICENSE_BUNDLE: NXPTNR100
1 When using UG versions prior to NX6, a UG license is not required. UG versions 9.0 and later utilize the SPLM_LICENSE_SERVER variable, while older versions utilize UGS_LICENSE_SERVER
2 UG is very sensitive about the environment variables. You should NOT have '/' at the end of UGII_BASE_DIR path and you MUST have '/' at the end of UGII_ROOT_DIR path.
3 It is advisable to specify %UGII_BASE_DIR\UGII\UGOpen directory at the beginning of PATH environment variable to avoid DLL version conflict.
Set up Catia V5 License
HyperMesh supports import of CATIA V5 models with .CATPart, .CATProduct and .cgr extensions.
If you intend to import CATIA V5 models, or CATIA V4 models embedded in CATIA V5 models, you must obtain a HyperWorks license file with the FEATURE CatiaV5Reader from Altair Engineering.
It is no longer necessary to install, update or manage the third-party library license file.
Appendix B: Local Installation on Windows (64-bit) - GUI Mode
1. Double click the installer executable file to start the installer.
If UAC (User Account Control) is enabled then a prompt will be displayed for elevated permissions. Click Yes to continue with installer.2. The multi-language selector prompt will be displayed. Select the proper locale and click OK to continue. The default locale setting is specific to the install machine regional settings.
The language selection only corresponds to the installer settings not to the HyperWorks product language settings. Altair HyperWorks products are in English.3. The Introduction panel is displayed for viewing. Click Next to continue.
4. The Sub-Installer List of installers picked up in the same residing directory as the Master installer will now be listed. Verify the list to make sure that the packages you wish to setup for installing are presently available and registered within the installer. Click Next to continue.
5. The Copyright, Trademark & Patents panel is displayed. Click Next to continue.
6. The Choose Installation Type panel is displayed. Choose install type Local install or Server install and click Next.
7. The Choose Install Folder panel is displayed. Choose the HyperWorks install directory and click Next.
a. The installer does not allow the use of characters # and ; b. Installing to a root drive is not permitted, example C:\
8. The Change Shortcut Folder (Local) panel is displayed. Choose a Start Menu name for the HyperWorks install and select whether desktop shortcuts are created. There are options on this panel to associate HyperWorks file types to products, and to generate thumbnail previews for HyperMesh files. Both are set by default. Once options are chosen, click Next to continue.
9. The Choose Install Set panel is displayed. Choose the products you wish to select. Products which do not have sub-installer present or picked up by the Master installer in the residing directory will be listed as (Unavailable) and not be able to be installed. Click Next to continue.
NOTE: Manufacturing Solutions and Engineering Solutions require both the hwdesktop and hwsolvers sub-installers to be present. The Help Files requires both the hwdesktophelp and hwsolvershelp sub-installers to be present.
10. (Only if Help was not selected to be installed) The Help Configuration panel is displayed.
Select one of the options:
a. Connect to a network installed Help location - Input the path, either UNC or drive path, to where the Help was installed to create the product link.
b. Connect to Altair website Help – This will allow the products to connect to the Altair website Help. A working Internet connection is needed for this functionality.
c. Set up Later – Allows for a post Help install over the current installation. This option will default to the website help if an Internet connect is established.
11. The Pre-Installation Summary panel is displayed which includes the Product Features list, Install Folder and disk space requirements. Review panel information and click Install to continue.
Install times are machine hardware dependent. Anti-Virus software may lengthen the install times. The HyperWorks sub-installer and Master installer may need to be allowed through any third party firewalls or virus scanning software in order to not be prompted during install time to allow them access to be installed.12. Once the installation completes, click Done to exit the installer.
Appendix C: Server Installation on Windows (64-bit) - GUI Mode
On Windows:
1. Double click the installer executable file to start the installer.
If UAC (User Account Control) is enabled then a prompt will be displayed for elevated permissions. Click Yes to continue with installer.2. The multi-language selector prompt will be displayed. Select the proper locale and click OK to continue. The default locale setting is specific to the install machine regional settings.
The language selection only corresponds to the installer settings not to the HyperWorks product language settings. Altair HyperWorks products are in English.3. The Introduction panel is displayed for viewing. Click Next to continue.
4. The Sub-Installer List of installers picked up in the same residing directory as the Master installer will now be listed. Verify the list to make sure that the packages you wish to setup for installing are presently available and registered within the installer. Click Next to continue.
5. The Copyright, Trademark & Patents panel is displayed. Click Next to continue.
6. The Choose Installation Type panel is displayed. Choose install type Local install or Server install and click Next.
7. The Choose Install Folder panel is displayed. Choose the HyperWorks install directory and click Next.
a. The installer does not allow the use of characters # and ; b. Installing to a root drive is not permitted, example C:\
8. The Change Shortcut Folder (Server) panel is displayed. Choose a Start Menu name for the HyperWorks install and select whether desktop shortcuts are created. Once options are chosen, click Next to continue.
9. The Choose Install Set panel is displayed. Choose the products you wish to select. Products which do not have sub-installer present or picked up by the Master installer in the residing directory will be listed as (Unavailable) and not be able to be installed. Click Next to continue.
NOTE: Manufacturing Solutions and Engineering Solutions require both the hwdesktop and hwsolvers sub-installers to be present. The Help Files requires both the hwdesktophelp and hwsolvershelp sub-installers to be present.
10. The UNC (Uniform Naming Convention) mount point panel is displayed if the install folder given was not a UNC path. Input the UNC path and click Next to continue.
NOTE: The user input needs to be in the form of the UNC standard
\\MachineName\SharedFolder\InstallFolder to be accepted.
11. (Only if Help was not selected to be installed) The Help Configuration panel is displayed.
Select one of the options:
a. Connect to a network installed Help location - Input the path, either UNC or drive path, to where the Help was installed to create the product link.
b. Connect to Altair website Help – This will allow the products to connect to the Altair website Help. A working Internet connection is needed for this functionality.
c. Set up Later – Allows for a post Help install over the current installation. This option will default to the website help if an Internet connect is established.
12. The Pre-Installation Summary panel is displayed which includes the Product Features list, Install Folder and disk space requirements. Review panel information and click Install to continue.
Install times are machine hardware dependent. Anti-Virus software may lengthen the install times. The HyperWorks sub-installer and Master installer may need to be allowed through any third party firewalls or virus scanning software in order to not be prompted during install time to allow them access to be installed.13. Once the installation completes, click Done to exit the installer.
Appendix D: Local Installation on Linux (64-bit) - GUI Mode
1. Open a command terminal window/prompt.
a. “cd” – change directory – to the location where the installer executable resides b. Execute the “sh” command on the installer binary, e.g. sh hw14.0_linux64.bin
2. The HyperWorks installer extracts the JVM (Java Virtual Machine) and the install modules to the TMP location of the machine and launches the installer. Example, below:
sh hw14.0_linux64.bin
Preparing to install...
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...
Launching installer...
NOTE: If the /tmp location on the machine is full, the installer will try to use the user’s home folder for temp files or the user can set the environment variable IATEMPDIR to a custom specified TMP location.
3. The multi-language selector prompt will be displayed. Select the proper locale and click OK to continue. The default locale setting is specific to the install machine regional settings.
The language selection only corresponds to the installer settings not to theHyperWorks product language settings. Altair HyperWorks products are in English.
4. The Introduction panel is displayed for viewing. Click Next to continue.
5. The Sub-Installer List of installers picked up in the same residing directory as the Master installer will now be listed. Click Next to continue.
6. The Copyright, Trademark & Patents panel is displayed. Click Next to continue.
7. The Choose Install Folder panel is displayed. Choose the HyperWorks install directory and click Next.
a. The installer does not allow the use of characters # and ;
b. Installing to a root drive is not permitted, example C:\ or “/” under Mac/Linux
8. The Choose Install Set panel is displayed. Choose the products you wish to select. Products which do not have sub-installer present or picked up by the Master installer in the residing directory will be listed as (Unavailable) and not be able to be installed. Click Next to continue.
NOTE: Manufacturing Solutions and Engineering Solutions require both the hwdesktop and hwsolvers sub-installers to be present. The Help Files requires both the hwdesktophelp and hwsolvershelp sub-installers to be present.
9. The Help Configuration panel is displayed. Input the path of the internet browser to be used with the HyperWorks Help. Click Next to continue.
10. (Only if Help was not selected to be installed) The Help Configuration panel is displayed.
Select one of the options:
a. Connect to a network installed Help location - Input the path, either UNC or drive path, to where the Help was installed to create the product link.
b. Connect to Altair website Help – This will allow the products to connect to the Altair website Help. A working Internet connection is needed for this functionality.
c. Set up Later – Allows for a post Help install over the current installation. This option will default to the website help if an Internet connect is established.
A valid Linux web browser will need to also be defined in this panel (HW_MSG_BROWSER).11. The Pre-Installation Summary panel is displayed which includes the Product Features list, Install Folder and disk space requirements. Review panel information and click Install to continue.
Install times are machine hardware dependent. Anti-Virus software may lengthen the install times. The HyperWorks sub-installer and Master installer may need to be allowed through any third party firewalls or virus scanning software in order to not be prompted during install time to allow them access to be installed.12. Once the installation completes, click Done to exit the installer.
Appendix E: Local Installation on Mac OS X (64-bit) - GUI Mode
The HyperWorks Mac OS X installer consists of two types of installers, zip and bin. The zip installers are used for launching the installer via Finder and will be considered as the GUI installer. The bin installers are to be used with the Master Installer and also for command line installs via the Terminal.
This example will use the required method for installing on Mac OS X by using the zip Master Installer and the sub-installers as bin installers.
1. Use Finder and click on the hw14.0_macosx64.zip file to extract it into an .app file. Then click on the hw14.0_macosx64.app to start the installer.
2. The multi-language selector prompt will be displayed. Select the proper locale and click OK to continue. The default locale setting is specific to the install machine regional settings.
The language selection only corresponds to the installer settings not to the HyperWorks product language settings. Altair HyperWorks products are in English.3. The Introduction panel is displayed. Click Next to continue.
4. The Sub-Installer List of installers picked up in the same residing directory as the Master installer will now be listed. Verify the list to make sure that the packages you wish to setup for installing are presently available and registered within the installer. Click Next to continue.
5. The Copyright, Trademark & Patents panel is displayed. Click Next to continue.
6. The Choose Install Folder panel is displayed. Choose the HyperWorks install directory and click Next.
Note: The installer does not allow the use of characters # and ;
Note: Installing to a root drive is not permitted, for example C:\ or “/” under Mac/Linux
7. The Choose Install Set panel is displayed. Choose the products you wish to select. Products which do not have sub-installer present or picked up by the Master installer in the residing directory will be listed as (Unavailable) and not be able to be installed. Click Next to continue.
NOTE: Manufacturing Solutions and Engineering Solutions require both the hwdesktop and hwsolvers sub-installers to be present. The Help Files requires both the hwdesktophelp and hwsolvershelp sub-installers to be present.
8. (Only if Help was not selected to be installed) The Help Configuration panel is displayed.
Select one of the options:
a. Connect to a network installed Help location - Input the path, either UNC or drive path, to where the Help was installed to create the product link.
b. Connect to Altair website Help – This will allow the products to connect to the Altair website Help. A working Internet connection is needed for this functionality.
c. Set up Later – Allows for a post Help install over the current installation. This option will default to the website help if an Internet connect is established.
9. The Pre-Installation Summary panel is displayed which includes the Product Features list, Install Folder and disk space requirements. Review panel information and click Install to continue.