Installing CATALYST Professional on Linux - CATALYST 2.0 SP3 and earlier versions

CATALYST Professional can be installed as a standalone or full-client configuration on Linux platforms. Please refer to the CATALYST Installation Manual for more information. The installation manual is found HERE.

If you are installing CATALYST 3.0.0 or later, please refer to our installation guide here for further details.

1. System requirements

CATALYST Professional can be installed on the following Linux operating systems:

• Ubuntu 20.04
• Ubuntu 22.04

More information on supported operating systems is found HERE.

2. Downloading CATALYST Professional

To download the CATALYST Professional software:

1. Download the software installation files from the CATALYST Earth Downloads webpage.
2. Save the .bin file to a location of your choice.

3. Linux dependencies

Before installing CATALYST Professional on Linux, you must have a number of dependencies installed on your computer. The list of dependencies varies by operating system. Scroll down to see the current list of dependencies or refer to the CATALYST Installation Manual for more information.

Note: You must be logged on as a superuser to install CATALYST Professional and the required dependencies.

3.1 Install dependencies individually

1. Open a terminal window.
2. Type sudo apt-get update
   • The command apt-get update is used to update the package index files on the system, which contain information about available packages and their versions.

3. Type sudo apt install python3-pip

4. Type pip install numpy requests shapely

5. Type sudo apt-get install gfortran 
6. Type Y to continue.

Additionally, run the command sudo apt-get install <library-name> to install each of the following libraries individually:

3.2. Install dependencies with a text file

1. To install the libraries as a collective, they can be installed using a text file. Open a text editor from the Applications menu.
2. Copy and paste the list of dependencies shown in the installation guide or above into a text file.

3. Save the file

4. Open a terminal window – CTRL T

5. Type xargs sudo apt-get -y install < /home/qa/Documents/dependencies

6. To ensure your dependencies are installed, choose one from the list and type apt list --installed | grep xchm

4. Installing CATALYST Professional

To install CATALYST Professional on Linux:

1. In a terminal window, navigate to the folder the software was copied to.

2. Change the permissions on the file to execute as a program.
   • Type sudo chmod +x and the file name.

3. At the command prompt, run the .bin file provided.
   • Type sudo ./CATALYST Professional--Full-Software-x86_64.bin
   • Press Enter.

4. At the end of the license agreement, type yes, and then press Enter to accept the terms and conditions.
5. Enter a location in which to install the software. Ensure that you have administrator access to the location you specify. You may also accept the default location.

6. Press Enter.

The installation is now complete. To run the software, you will need to set the environment variables and create an alias that provides a shortcut to CATALYST Professional.

5. Licensing the software

You can license CATALYST software as a standalone or full-client installation on Linux platforms. The license mode is based on which environment variable you use and where the license file to run CATALYST is stored.

By default the software will be installed as a standalone application. A trial license lets you run the software for a period of 7 days, which begins when you use the software for the first time. The trial period is valid only before the designated expiration date, which is noted in the table at the bottom of the CATALYST License Utility window.

5.1. Installing as a standalone application

In Standalone mode, you install and license CATALYST on one computer. Standalone mode is determined by setting the PCILICENSEFILE environment variable to point to the location of the license file and importing the license into the CATALYST License Utility.

Open the License Utility panel. This can be done in the following ways:

• Navigate to the exe folder of your CATALYST installation, type ./licenseutility, and then press Enter.

• For CATALYST Professional only: On the CATALYST Professional toolbar, click the CATALYST License Utility button.

The License Registration panel opens.

5.2. Requesting a license file for your software

To obtain a license file, send your request in an email message to CATALYST Customer Support at: [email protected].

Your request for the license file must contain the following information:

1. Your customer number (if applicable)
2. Your name
3. Company name
4. Email address at which you want to receive the license file
5. Product or products to license
6. Version
7. Fingerprint

5.3. Saving and importing a license file

After you receive the license file from CATALYST Customer Support:

1. Open the CATALYST License Utility.
2. In the CATALYST License Utility window, click Import.
3. The File Selector window appears. Navigate to the folder in which you saved the license file, select the file, and then click Open.
4. The CATALYST License Utility window appears, displaying the details of your license. At the bottom of the window, the number of entries (rows) in the table correspond to the number of licenses.

Note: At least one fingerprint in the table must match the value in the Fingerprint box under Computer
Configuration.

6. Installing as a server and client application

In Full Client mode, you install CATALYST on one or more computers and borrow the license from a license server installed on your network. Full Client mode is determined by setting the PCILICENSESERVER environment variable to point to a license server.

Note: To install the license server, you must be logged in as an administrator or have administrator privileges.

6.1 Linux license server dependencies

To install the license server, the libc6-i386 package is required.

1. In a terminal window type sudo apt-get install libc6-i386
2. Press Enter.

6.2 Installing the license server

Before you can license your server client installation as a full client, you must install
the license server. The license server is a program that manages licenses for client installations. Clients are installed on various computers on your network. CATALYST uses the Sentinel RMS License Manager for the license server.

Note: If a graphical interface is required, the license server can be installed on a Windows operating system which can be accessed from the Linux machine to request a license token. Alternately, it can be installed on a Linux machine as shown below.

To install the license server on a Linux machine:

1. Download the software from the CATALYST Earth Downloads webpage.
2. Save the LicenseServer-*.bin file to a folder on your server.
3. Change the permissions on the LicenseServer-*.bin file to run as a program.
4. Type sudo chmod +x and the file name.
5. At the command prompt, run the LicenseServer-*.bin file.
6. Type sudo ./CATALYST-License-Server-Install-ubuntu22.04.bin
7. Press Enter.
8. The license-server program is installed in the /opt/catalystlic folder.

• Note: The /opt/catalystlic/exe folder contains the Sentinel RMS License Manager program files. The /opt/catalystlic/help folder contains the Sentinel RMS License Manager help files.

7. Generating a fingerprint for your server machine

You require a fingerprint code to obtain a license from CATALYST Customer Support for the license server.
Note: You need not be logged in as an administrator nor have administrator privileges to generate the fingerprint.

To find the fingerprint code:

1. Navigate to /opt/catalystlic/exe and run the echoid program by typing ./echoid
2. The fingerprint code appears in the terminal. Use the first locking code listed.
3. In keeping with the example below, this would be Locking Code 1 : 14-*16N RBLV V7UG UMEH.

8. Requesting a license file

To obtain a license file, send your request in an email message to CATALYST Customer Support at: [email protected].

Your request for the license file must contain the following information:

1. Your customer number (if applicable)
2. Your name
3. Company name
4. Email address at which you want to receive the license file
5. Product or products to license
6. Version
7. Fingerprint

9. Loading the license into the license server

After you receive your license file from CATALYST Customer Support, you must load it into the license server. The license file you receive will be named in the following format: license_10_none_16-Sep-2023.PCI. The license file can be copied to any location on your server.
Note: You must be logged in as an administrator or have administrator privileges to load the license.

To load the license into the license server:

1. Navigate to the /opt/catalystlic/exe folder.
2. Confirm that the server is running by typing the following at the prompt: service lservd status
   • If the server is not running, type: service lservd start
   • Tip: Alternatively, you can type: ./lserv
     

After the system restarts, the license server restarts and the license codes in the lservrc file load automatically into the server.

3. To load the license codes into the license server, type ./lslic -F /'<path>'/license_10_none_date.PCI

The license codes are also copied into /opt/catalystlic/exe/lservrc, which is a text file that contains the license information. After the system completes this operation, the license server is ready to issue the license tokens.

10. Setting the environment variable

Please refer to the Appendix A section in the CATALYST Installation Manual for more information on setting environment variables. The CATALYST Installation Manual is found HERE.

The environment variables can be set locally or globally.

10.1 Set the environment variable for this instance

Software run from this terminal will have the environment variables set as follows:

1. Navigate to the /opt/catalystlic/exe directory.
   • Type cd <path>/opt/catalystlic/exe
2. Type export PCILICENSESERVER=localhost
   • Alternately, type the computer name or IP address of your server machine.
3. Press Enter.

10.2 Set the environment variables globally

Setting the environment variables globally will apply the variables to this profile. Multiple terminals can be launched and the same environment variables will be used to launch the software.

1. Navigate to the .bashrc file in the home directory.

2. In file explorer, double click .bashrc to open it in a text editor.
You may need to show hidden files by selecting a blank area of the window and entering CTRL + H

3. When the file opens, type the environment variables required for your installation.

For a server and client installation, type export PCILICENSESERVER=localhost or computer name

For a standalone installation, type export PCILICENSEFILE=/opt/catalystpro/exe/License.PCI

To verify that the environment has been set

type source .bashrc

printenv | grep PCILIC

To verify that your installation is checking out a license from the license server:

• Open the License Utility.
• Notice the Licensing Mode shows Client and the Identifier is LOCALHOST as previously specified.

To switch your installation to a standalone application:

• The PCILICENSEFILE environment variable must be set explicitly to the location where the valid License.PCI file resides. This location is normally $PCIHOME/exe/License.PCI. The PCILICENSEFILE variable allows the software to point directly to the valid License.PCI file (not to the folder containing the file, but to the file itself).

11. Running the software

To run CATALYST Professional:

1. Navigate to the /opt/catalystpro/exe directory.
2. Type ./catalystpro
3. The CATALYST Professional toolbar and a Focus window will open.