User Guide

Installation of CMG Software

on Linux 2022

cmgl.ca #FutureOfSimulation
22.CMG.02
 Contents
Overview ................................................................................................................................... 3
Getting Started ......................................................................................................................... 4
Security Upgrade to RLM 12.3 .............................................................................................................. 4
Installation Best Practices ...................................................................................................................... 4
System Requirements............................................................................................................................ 4
Minimum System Requirements ....................................................................................................................... 4
Recommended Hardware for Simulation of Large Models ................................................................................ 4
Checking your Operating System Level ............................................................................................................ 5
Preparing to Install ................................................................................................................................. 5
Logging in as root ............................................................................................................................................. 5
Checking for Actively Running CMG Software .................................................................................................. 5
Accessing the Installation File ........................................................................................................................... 6

Determining the Licensing Configuration ............................................................................. 7

Installing the Software ............................................................................................................ 8
Sending the Hostid Information to CMG ................................................................................................ 8
Generating a hostid for a Different Workstation ................................................................................................ 9
Starting the License Server ................................................................................................................... 9
Manually Starting the RLM Server .................................................................................................................. 10
Starting the RLM Server at System Boot Time on Unix Systems.................................................................... 10

Setting Up the Environment ................................................................................................. 12

Required Environment Variables ......................................................................................................... 12
Linux_x64 Runtime Environment ......................................................................................................... 13
Setting LD_LIBRARY_PATH .......................................................................................................................... 13
Linux_x64 Runtime Libraries ............................................................................................................... 14
Required Runtime Libraries for 2022.10 Linux_x64 versions of GEM, IMEX, STARS .................................... 14
Checking for the Runtime Libraries ................................................................................................................. 14
Installing the Runtime Libraries ....................................................................................................................... 15

Installing the License File ..................................................................................................... 16

Running Simulations with the RunSim Script .................................................................... 17

Installation of CMG Software on Linux 2

 Overview
Installation of CMG Software on Linux† workstations involve a number of steps:
1. Ensure that the workstation meets the system requirements.
2. Make the installation available to the workstation.
3. Determine the licensing and CEIP configuration you are using.
4. Install the software on the workstation via an installation script.
5. Configure the environment.
6. If the computer is a Network License Server or a Standalone Client, install the License File.
CMG has automated these steps as much as possible using a Bourne shell script.

Note: CMG Software is provided on two releases. The Windows† release has a 'W' in the name,
and the Linux† release has a 'U' in the name. For example, 2022.101.GW is a Windows release
and 2022.101.GU is a Linux release.

Installation of CMG Software on Linux 3

 Getting Started
Security Upgrade to RLM 12.3
We have upgraded the version of Reprise’s RLM software to version 12.3. We recommend that
anyone upgrading their license servers do the following:
1. Check in any roaming licenses that may be in use.
2. Stop any long-running simulations and write restarts for them.

Note: Failure to do the above may result in unpredictable behavior.

Installation Best Practices

1. Before you install CMG software on a Linux workstation, you should ensure that the
workstation meets the minimum system requirements. The Minimum System Requirements
and Recommended Hardware for Simulation of Large Models sections describe both the
minimum and recommended system specifications for CMG software respectively.

2. Installation of CMG software requires access to the installation files. This may require
root access to the computer.

System Requirements
Minimum System Requirements
CMG software will run on the following platforms:
• Intel† x64 computer with minimum Red Hat Enterprise Linux 7.2 operating
system, recommended Red Hat Enterprise Linux 8.4.

Note: CMG software is tested at the levels listed. A higher OS level is allowed, as long as it is
backwards compatible with the listed OS level.

Each platform must also have the following:

• 8 GB RAM
• 4 GB free hard drive space
Recommended Hardware for Simulation of Large Models
Medium Large Models
Up to 2,000,000 active blocks for IMEX™, GEM™, and STARS™
• 1 or 2 eight-core Intel Xeons† or better
• 32 GB RAM or more
Large Models
Up to 5,000,000 active blocks for IMEX™, GEM™, and STARS™
• 2 twenty-core Intel Xeon Gold 6148 or similar
• 96 GB RAM or more

Installation of CMG Software on Linux 4

 Very Large Models
More than 5,000,000 active blocks for IMEX™, GEM™, and STARS™.
• 4 eighteen-core Intel Xeon Gold 6154 or similar
• 192 GB RAM or more
Checking your Operating System Level
Linux has several options for showing your operating system level. In some cases, the
operating system name and level are displayed as you log in to the computer. To determine
the OS level for each platform, use the following method:
Red Hat Linux
The file /etc/redhat-release contains the current release information. Use the following
command to see it:
cat /etc/redhat-release
This will give output in the following format:
Red Hat Enterprise Linux Server release 6.2 (Santiago)
To find the exact kernel and platform, use the uname command with the –inrs options as
follows:
uname –inrs
This will give output in the following format:
Linux valhalla 2.6.9-42.ELsmp x86_64
In this case "Linux" is the operating system name. "valhalla" is the name of the computer.
2.6.9-42.ELsmp is the release (kernel) level. "x86_64" is the machine type for x64. For 32-bit
computers, the machine type would be "i686".

Preparing to Install
Logging in as root
You may need to log in as root user for the installation script to function correctly. The
installation script may not be able to install the files to the desired location as a normal user.
In addition, a normal user may not be able to mount the installation files.
Checking for Actively Running CMG Software
Installing a new version of CMG software should not interfere with any currently installed
CMG versions. If any CMG software is running on the computer, it can be left running while
the installation of the new software proceeds.
If you do need to determine if CMG software is running, you may use the ps command to
search for each of the simulators individually:
ps –edaf | grep st
ps –edaf | grep mx
ps –edaf | grep gm

Installation of CMG Software on Linux 5

 These commands will list any running process containing “st”, “mx”, or “gm” in their names.
CMG’s software follows a particular naming convention for its simulators:
styyyyxx.exe
mxyyyyxx.exe
gmyyyyxx.exe
where yyyy is the year of the release and xx is the version within that year. For example,
st202210.exe is version 10 of the release of STARS for 2022.
Accessing the Installation File
Ensure that the installation files are accessible on the computer, and make a note of where
they are. This can include mounting an external media device (CD-ROM, thumb drive, etc.),
downloading the files directly from the Internet, or simply copying the files. Once there, the
directory and files within should be readable and executable. Your local IT department
should be able to assist you.

Installation of CMG Software on Linux 6

 Determining the Licensing Configuration
CMG software supports two different licensing configurations on Linux. The one you use
depends on the type of licensing model you have purchased.
• Network License Client: Licenses are provided by a Network License Server computer
elsewhere on the network. As part of the installation, you will need to know the name of
the Network License Server computer.
• Network License Server: The computer will serve licenses to other Network License
Client computers on the network. You may install all the CMG software on this computer
or you may choose to install just the licensing server software. A Network License
Server requires a License File.
Network License Servers are also Customer Experience Improvement Program (CEIP) servers.
You will have the option to automatically start up the CEIP software if you choose a Network
License Server installation.
During installation you will be prompted as to whether you wish to generate a hostid for the
computer. You will only need to do this if this computer will be a Network License Server.
After installation, you will be required to set the CMG_LIC_HOST environment variable to point
to the name of the computer that will be providing licenses. This is the case for both licensing
configurations.

Installation of CMG Software on Linux 7

 Installing the Software
CMG provides an installation script called unixinst.sh as part of the installation. This script is a
Bourne shell script, and you may examine it to see what it does.
To begin the installation using the script, move to the installation file directory. For example, if
the installation is part of a CD-ROM and is mounted under /cdrom, you would use the following
command:
cd /cdrom

If the files are in another directory (a file share, for example) you’ll need to change to that location
instead.
To run the script from the installation directory, you would enter:
./unixinst.sh

Follow the instructions as the script executes. The script requires the following information:
• Directory in which you want the software installed (/opt/cmg is a good location, but the
software can reside anywhere there is sufficient space).
• Directory where the installation files are. i.e. the directory above.
• Whether this computer will be used as a Network License Server.
• If it is a Network License Server, whether you want the Customer Experience
Improvement Program (CEIP) software to run automatically.
Whether you wish to generate a Hostid for the computer you are installing on (required if the
computer is a Network License Server).

Important: If this machine will be part of a computer cluster such as LSF, OGE or PBS, you will
need to follow additional installation steps such as configuring your cluster for the new node,
making sure files are properly shared, and installing the cmgsimrun executable to the PATH.
Starting 2020.10, the CMG Linux installation script now installs the cmgsimrun executable under
the Launcher folder and adds a symbolic link in /usr/local/bin. Refer to the “Setting up Remote
Schedulers” section of the Launcher User’s Guide for information specific to your cluster
software for additional information.

Sending the Hostid Information to CMG

If you elect to generate hostid information when running the installation script, a file called
hostid.info is created in your CMG_HOME directory. The next step is to send this file to CMG so
that we can create a License File locked to the computer.
The hostid.info file has space for you to add your name, company name, location, telephone
and fax number. If for some reason you are not installing all of the software your company is
entitled to on this machine (if you run some of the software at another location, for example),
use the space provided to tell us which products you want authorization codes for.
When you have finished adding the required information to hostid.info, you can email it to us at
[email protected]. We will generate a License File and send it back to you.

Installation of CMG Software on Linux 8

 Generating a hostid for a Different Workstation
If the computer you want to run the license manager on is different from the computer on which
you installed the CMG software, you can generate the hostid by running the cmghostid utility. If
you installed your software in /opt/cmg, you would enter: (Note that CMG_HOME must be set for
this script to work correctly).
/opt/cmg/rlmsecure/cmghostid.sh

This will produce output similar to the following (actual numbers will differ):
HOST ID INFORMATION (VERSION 2022.00)
Please fax or email this form to CMGL at:
Computer Modelling Group Ltd.
Attention: License Coordinator
Address: 3710 33 Street NW. Calgary, AB., Canada T2L 2M1
Phone: 1-403-531-1300
Fax: 1-403-289-8502
Email: [email protected]
Customer Information
Name: Jane Doe
Company: Doe & Associates Ltd.
Location: Calgary, AB
Phone: 403-555-1234
Fax: 403-555-5678
Email: [email protected]
Site Code and License Configuration Information:
Host name: valhalla
Host ID Information:
001e4fdf75a7
ip=123.45.67.89
host=valhalla
Operating System Red Hat Enterprise Linux Server release 6.2 (Santiago)
OS Info Linux 2.6.18-128.el5 x86_64
MACHTYPE x86_64-redhat-linux-gnu
CMG_PLATFORM linux_x64
Environment Variables:
CMG_HOME=/opt/cmg
CMG_LIC_HOST=valhalla

Send this information to us at [email protected] and we will generate a License File and
send it back to you.

Starting the License Server

If the computer will be used as a license server, you can manually start the licensing service
using the RestartRLM script. This script can be found in the CMG_HOME directory. You can
also set up the license server daemon to start automatically.

Note: Although you can start the License Server at this point, it will not provide you with any
licenses until you install the License File provided by CMG.

You can check the status of your licenses using a Web browser. Start the browser and go to
URL http://localhost:5054/. See A Guide to Using CMG Licensing for more information.

Installation of CMG Software on Linux 9

 Manually Starting the RLM Server
Run the script RestartRLM.sh in a shell terminal.
Starting the RLM Server at System Boot Time on Unix Systems
On most Unix systems, system services are started at boot time, usually via startup scripts
located in /etc/rc.<something>. For example, on Linux systems, the script could be located
in /etc/init.d/rlm, with a link to /etc/rc5.d/S98rlm. Note that you must install this startup script
as root.
The startup script should su to a different user so that the rlm servers are not running as root.
The following is an example of a script which would start rlm at boot time on Unix systems.
Modify the first 5 variables for the target system.
#! /bin/sh
#
# rlm Start/Stop rlm
#
#----------------------------------------------------------------
# NOTE: Configure these 6 variables for your system

# Set rlmuser to the user under which rlm will run

rlmuser=maxwell

# Set root directory for sub-platforms

rlmsecure=/opt/cmg/rlmsecure

# Set rlmdir to the directory where the rlm binary is found

rlmdir=${rlmsecure}/linux_x64

# Set rlmdowndir to the directory where the rlmdown binary is found

rlmdowndir=${rlmdir}

# Set licfile to the path to the license file

licfile=${rlmsecure}/cmgl.lic

# Set debuglog to the path to the debug log

debuglog=+${rlmsecure}/logs/rlm.dl
#----------------------------------------------------------------

Installation of CMG Software on Linux 10

 start() {
echo $debuglog
su - $rlmuser -c "$rlmdir/rlm -c $licfile -dlog $debuglog &"
}

stop() {
su - $rlmuser -c "$rlmdowndir/rlmdown RLM -q"
}

case "$1" in
start)
start
;;
stop)
stop
;;
restart)
stop
sleep 2
start
;;
*)
echo $"Usage: $0 {start|stop|restart}"
exit 1
esac

exit 0

Installation of CMG Software on Linux 11

 Setting Up the Environment
In order to properly run CMG software on a Linux computer, you must ensure that the environment
has been configured properly. This includes the setting of a number of environment variables, and
ensuring that you have the appropriate runtime libraries installed.

Required Environment Variables

CMG Software requires a number of environment variables to be set in order to ensure proper
operation. You must set these variables at the end of the installation, either manually whenever
using the software or in the appropriate startup files (such as .cshrc, .kshrc, .login, etc.).
The following table describes these environment variables.
Environment Variable Description
CMG_HOME The directory where CMG software is installed. It is recommended that all
versions of CMG software be installed under CMG_HOME.
CMG_LIC_HOST The name or IP address of the computer running the license server that
will be used by CMG applications running on this computer. You can
specify a computer name, a fully qualified computer name with domain,
or an IP address. If this computer will be used as a license server, you
can use 127.0.0.1 or the computer’s name.
If the license server is using a port other than the default, you can use
name:port syntax.
LD_LIBRARY_PATH The location of the libraries used by the simulators. Each simulator has a
lib directory which should be added to the path. The lib for a given
simulator will be located in:
<CMG_HOME>/<simulator>/<version>/<platform>/lib

For example, if CMG_HOME is /opt/cmg, the library directory for

STARS 2022.10 on Linux_x64 would be
/opt/cmg/stars/2022.10/Linux_x64/lib

If you are using the C-shell, you will want to add the following lines to your .cshrc file:
set CMG_HOME=/put/your/CMG/path/in/here
set CMG_LIC_HOST=computer_name:port
set LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/lib/path/here

If you are running in the Korn shell (or one of its derivatives), add these lines:
export CMG_HOME=/put/your/CMG/path/in/here
export CMG_LIC_HOST=computer_name:port
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/lib/path/here

Note: The current release of CMG software supports having multiple versions of all three
simulators on a single LD_LIBRARY_PATH environment variable. Future versions may present
conflicts, however. You may want to limit the number of versions in the LD_LIBRARY_PATH to
avoid conflicts. You can also make use of the RunSim script (described in Error! Reference
source not found.) to set the variable on a per-run basis.

Installation of CMG Software on Linux 12

 Linux_x64 Runtime Environment
In order to allow running of a single executable across different implementations of Linux, CMG
simulators use dynamic links of glibc runtime libraries and IMEX and STARS use dynamic links
of Intel runtime libraries. GEM is linked statically with the Intel libraries.
GEM, IMEX, and STARS 2021.10 were built on RHEL 6.2 and are supported on RHEL 7.2,
RHEL 7.5, RHEL 7.6, RHEL 7.7, RHEL 8.1 and RHEL 8.2.
GEM, IMEX and STARS 2022.10 were built using INTEL Fortran and INTEL C/C++ Compiler
Version 19.0.5.281.
For IMEX and GEM, the compiler version may be determined by using the command-line
argument, without quotes, ‘-compiler_info’. For STARS, the compiler version may be
determined by using the command-line argument, without quotes, ‘-cputime’.
The standard C++ and gcc x64 runtime libraries are required. See Readme_Linux_libs_2022.pdf for
details.
For IMEX and STARS an environment variable LD_LIBRARY_PATH must be set so that the
exe can locate the Intel runtime libraries. For GEM, setting LD_LIBRARY_PATH is not required
as GEM is linked statically with the Intel libraries.
Setting LD_LIBRARY_PATH
To accomplish this, the runtime libraries are stored at the following location:
${CMG_HOME}/simulator/version/platform/lib
where simulator = GEM/IMEX/STARS; version = current version, e.g. 2022.10; platform = linux_x64.
This assumes that the environment variable CMG_HOME was setup during installation to point
to where the simulators are installed.
So, for instance, if IMEX was installed in /usr/cmg, then for bash shells and IMEX 2022.10 on
linux_x64, the environment variable LD_LIBRARY_PATH must be set as follows:
export LD_LIBRARY_PATH=/usr/cmg/imex/2022.10/linux_x64/lib

The 2022.10 version of CMG Launcher (with LSF, SGE or PBS/Torque support) will set this
environment variable automatically for the user if a job is being submitted to run a simulator on a
Linux_x64 machine. The CMG_HOME environment variable must be set correctly.
See the document Readme_Linux_libs.pdf for information on determining the versions of
runtime libraries.

Installation of CMG Software on Linux 13

 To obtain a list of runtime libraries required, including the Intel OpenMP and MKL runtime
libraries, the command ldd may be used. For instance, on a machine with Linux x64 RHEL 7
update 6, the following was obtained:
$ ldd mx202210.exe
linux-vdso.so.1 => (0x00007ffea489a000)
libz.so.1 => /lib64/libz.so.1 (0x00007fcb7056a000)
librt.so.1 => /lib64/librt.so.1 (0x00007fcb70362000)
libmkl_intel_lp64.so => /usr/cmg/imex/mx2022.10/linux_x64/lib/libmkl_intel_lp64.so (0x00007fcb6f7ea000)
libmkl_def.so => /usr/cmg/imex/mx2022.10/linux_x64/lib/libmkl_def.so (0x00007fcb6cf99000)
libmkl_intel_thread.so => /usr/cmg/imex/mx2022.10/linux_x64/lib/libmkl_intel_thread.so (0x00007fcb6aa2c000)
libmkl_core.so => /usr/cmg/imex/mx2022.10/linux_x64/lib/libmkl_core.so (0x00007fcb666fb000)
libm.so.6 => /lib64/libm.so.6 (0x00007fcb663f9000)
libiomp5.so => /usr/cmg/imex/mx2022.10/linux_x64/lib/libiomp5.so (0x00007fcb66004000)
libpthread.so.0 => /lib64/libpthread.so.0 (0x00007fcb65de8000)
libc.so.6 => /lib64/libc.so.6 (0x00007fcb65a1b000)
/lib64/ld-linux-x86-64.so.2 (0x00007fcb70780000)
libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x00007fcb65805000)
libdl.so.2 => /lib64/libdl.so.2 (0x00007fcb65601000)
$

Linux_x64 Runtime Libraries

Required Runtime Libraries for 2022.10 Linux_x64 versions of GEM, IMEX, STARS
There are three Red Hat RPM packages for Linux_x64 which must be installed in order to
provide the required runtime libraries for the CMG simulators. The packages for RHEL 7.2
are:
glibc-2.12-1.47.el6.x86_64
libgcc-4.4.6-3.el6.x86_64
libstdc++-4.4.6-3.el6.x86_64

With the 2022.10 release, CMG supports RHEL 8.2. The 2022.10 release was built on a
machine with RHEL 7 update 2.
Checking for the Runtime Libraries
To determine whether the required RPM packages are installed, run the following
commands:
rpm -qa glibc
rpm -qa libgcc
rpm -qa libstdc++

Output from each of these commands may list zero, one or two installed packages. For
libstdc++, more than two may be listed, but ignore the ones that are not named exactly
libstdc++-x.x.x-xx (e.g. ignore libstdc++-devel-x.x.x-xx).

Note that 32-bit packages end in .i686 while 64-bit packages end in .x86_64.

Installation of CMG Software on Linux 14

 Installing the Runtime Libraries
The required RPM packages can be installed in one of two ways:
1. Automatically using the Red Hat Linux Update Agent yum. The Update Agent
automatically resolves any dependencies, so that any packages which are
prerequisite to another package will be installed first. Consult your Red Hat Linux
documentation for more information on using yum.
2. Manually by downloading the RPMs from the Red Hat Linux website, then installing
the RPMs. Note that in this case any dependencies will have to be resolved
manually.
Please contact your system administrator for assistance in choosing one of these installation
methods.

Installation of CMG Software on Linux 15

 Installing the License File
If you are installing a Network License Client, your installation is now complete.
If you are installing a Standalone Client or a Network License Server and you already have
functioning CMG software on this computer, your installation is now complete.
If you are installing a new Standalone Client or a new Network License Server, you need to
send the hostid information generated during the installation to CMG. We will generate a
License File that authorizes the use of your licensed CMG applications and will email this file
back to you.
Information on installing your License File is provided in A Guide to Using CMG Licensing.

Installation of CMG Software on Linux 16

 Running Simulations with the RunSim Script
Each of the three simulators (GEM, IMEX, STARS) has an extensive manual describing how to
run them. CMG also provides a script for simple invocation of the simulators called RunSim.sh.
The RunSim.sh script is installed in the CMG_HOME directory by default. It is designed to take
input from the user that describes the name and version of the simulator to be run, and the
location of the input dataset. Based on this information, the script does the following:
• Determines the full path of the simulator executable from the name and version of
simulator provided by the user in conjunction with the CMG_HOME environment variable,
• Determines the value of the LD_LIBRARY_PATH environment variable from the full path
of the simulator executable file, and
• Starts the simulator with the name of the input dataset.
The output of the simulator is put in the current working directory. If the path to the dataset
contains any white space, it should be quoted.
You may examine the contents of the RunSim.sh script, and you may tailor it to your needs.
Additional command-line options can be given to RunSim.sh and these are passed directly to
the simulator.
Example 1: Running STARS 2022.10 on the local data file sttst01.dat:
RunSim.sh stars 2022.10 sttst01.dat

Example 2: Running GEM 2022.10 on a data file using a relative path:

RunSim.sh gem 2022.10 ../tpl/frr/gmfrr001.dat

Example 3: Running IMEX 2022.10 on a data file using an absolute path:

RunSim.sh imex 2022.10 /opt/cmg/imex/2022.10/tpl/spe/mxspe001.dat

Example 4: Running IMEX 2022.10 on a local data file using additional command-line options
to use parallel processing:
RunSim.sh imex 2022.10 mxspe001.dat –doms –parasol 4

Installation of CMG Software on Linux 17