2. Electronics Installation - Linux
2. Electronics Installation - Linux
ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand,
product, service and feature names, logos and slogans are registered trademarks or trademarks
of ANSYS, Inc. or its subsidiaries located in the United States or other countries. ICEM CFD is a
trademark used by ANSYS, Inc. under license. All other brand, product, service and feature
names or trademarks are the property of their respective owners. FLEXlm and FLEXnet are
trademarks of Flexera Software LLC.
Disclaimer Notice
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license
agreement, the use, duplication, or disclosure by the United States Government is subject to
restrictions stated in the ANSYS, Inc. software license agreement and FAR 12.212 (for non-
DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for Ansys pro-
prietary software and third-party software. If you are unable to access the Legal Notice, please
contact ANSYS, Inc.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Table of Contents
Table of Contents Contents-1
TCP/IP 1-2
OpenGL 1-2
Contents-1
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Registering Ansys Electromagnetics Product Engines for use with RSM 3-10
Limitations 3-14
Test #2: Submitting and Running a Non-MPI Job Distributed to Multiple Hosts 3-17
Test #3: Submitting and Running an MPI Job Distributed to Multiple Hosts 3-18
Contents-2
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Contents-3
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Index C-2
Contents-4
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
1 - Getting Started
Installation Prerequisites
Before installing Ansys Electromagnetics Suite software, you will need:
l Ansys Electromagnetics physical product (USB or DVDs), or digital download.
l Includes software, example projects, and documentation.
l For additional information, see: Additional Resources (Page 1-3).
l A license file (see: License File below).
l Ansys License Manager (see: Ansys License Manager below).
l TCP/IP installed, for counted evaluation and purchased licenses (see: TCP/IP below).
l A computer that meets the minimum or recommended system requirements for the Elec-
tromagnetics products you plan to run.
l For detailed requirements, visit: https://www.ansys.com/it-solutions/platform-sup-
port.
License File
Most Ansys Electromagnetics products require a license, which is sent as an e-mail attachment.
After you receive a license file, save it to a temporary location.
The license file requires a license hostid, which is a hardware device used to validate the license.
For a list of supported hostids and a general explanation of hostids, see: Appendix B.
If you do not have a license file for the Ansys Electromagnetics software you are about to install,
please contact your Ansys sales representative.
The Ansys License Manager must be installed in one of the following locations:
l On the computer where the software will be installed.
l On another machine accessible over the network.
Note:
You can install Ansys License Manager before or after installing Ansys Elec-
tromagnetics software.
Additional instructions are included as part of the Ansys License Manager download.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
TCP/IP
Transmission Control Protocol/Internet Protocol (TCP/IP) is required to use any Ansys Elec-
tromagnetics Suite software—even for a single computer in stand-alone mode.
l TCP/IP must be installed on the machine that is running Ansys License Manager (the
server) and on each machine that obtains licenses from that server.
l TCP/IP is usually bound to a network card. If a network card is already installed and set up
for TCP/IP, no additional action is needed.
OpenGL
Ansys Electromagnetics applications make use of OpenGL libraries. You will need to install
OpenGL libraries if you experience sluggishness when interacting with the UI, or if you see any
of the following errors:
l Unable to resolve function glXQueryExtension
l Failed to initialize an OpenGL view
Ansys recommends the use of OpenGL libraries provided by the manufacturer of the graphics
card in your machine or by the PC or laptop manufacturer. For the latest information, please visit
the following Ansys Help web pages:
l Ansys Platform Support
The following tables within this webpage are applicable to the Electromagnetics Suite
products:
o Table 2.1: Packages Required for the Installer to Run
o Table 2.2: Common packages that may be required for all products
o Table 2.11: DCS (Distributed Compute Services)
o Table 2.19: Mechanical Products
o Table 2:22: optiSLang
o Table 2.23: Parasolid Geometry Interface
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Additional Resources
Ansys Website: https://www.ansys.com
Downloads: Software downloads (including Ansys License Manager) and install-
ation-related documentation are available at the Ansys customer portal,
https://support.ansys.com
Online Technical Available through the Ansys customer portal: https://support.ansys.com
Support: Under Training & Support, select from tutorials and training materials
or click Support Contacts for contact information.
Product Docu- The online help is accessible from any Electronics product's Help
mentation: menu. Information about the release can be found in the What's New
documents.
PDF versions of the documentation can be found in the online help, or
downloaded via the Downloads link on the customer portal: https://sup-
port.ansys.com
How-To Videos: Video instructions for installation are available at https://www.y-
outube.com/channel/UCdymxOTZSP8RzRgFT8kpYpA
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Installing Ansys Electromagnetics Suite on a Linux system generally involves the following
steps:
Note:
On every machine where you are going to run the software, you also need enough
swap space to accommodate at least the amount of RAM on the machine. Contact your
system administrator if you have questions about swap space.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
If you receive an error that InstallAnywhere did not find enough temporary space
to run:
4. Click Next.
5. Read the license agreement carefully. Select I accept the terms of the License Agree-
ment to proceed.
6. Click Next.
7. Under Where would you like to install?, do one of the following to accept the default
path or specify a different one:
l Do nothing to accept the listed default installation folder.
l To select a different folder, click Choose. The Select a Folder window appears. Nav-
igate to the desired installation folder and click Select.
If you have other Ansys Electromagnetics software, Ansys recommends that you
install it in the same folder.
l To create a new folder, click Choose. The Select a Folder window appears. Nav-
igate to the parent folder where you want to create the new installation folder. Then,
append the new folder name to the path in the Folder Name field. Alternatively, you
can click the Create New Folder icon; rename the folder while the default name,
NewFolder, is still selected; and then press Enter. Finally, click Select to accept the
specified folder.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
Multiple machines/nodes can run from the same installation tree. You do
not have to install the application on each Linux machine/node. Ansys
recommends installing to a network path.
8. Click Next.
Depending on the software and version being installed, you may see one or both of the fol-
lowing screens:
l Select Temporary Folder
l Choose Library Option
9. If the Select Temporary Folder screen appears, select a default location for all simulations
(including local) to use as a temporary work space.
l If desired, change the temporary folder assignment. You can edit the field directly or
use the Choose button to display a folder browser window for navigating the folders
on your machine and network.
l If desired, check the option to Add read/write access for all users to the Temp
directory.
If the installation will be used for remote simulation by multiple users, all users must
have permissions to access the temporary folder.
10. If the Choose Library Option screen appears, do one of the following to specify the loc-
ation of the Ansys Electromagnetics libraries:
Note:
Ansys Electromagnetics libraries are large databases of electronic components,
developed by Ansys and various manufacturers.
l Click This local installation to copy and install the default Ansys Electromagnetics
component libraries.
l Click The following common installation to use libraries that are already installed
(locally or on the network). Click Choose, select the appropriate path, and click
Select.
If an existing license configuration is found, it is shown near the top of the License Inform-
ation screen.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
A redundant server setup requires three license servers, each
serving an identical license file. The order in which the servers are
entered must match the license files on each server.
d. Select or clear the Specify TCP/IP Port option. Specifying a TCP/IP Port
means that the software only looks to that port for licenses. For Redundant
servers, you must enter a port. The default port for Ansys License Manager is
1055.
e. Click Next.
l I want to keep the current license configuration – Select this option if you
already have a license configuration for a previous version of Ansys software and
want to keep the same configuration. Then:
a. Click Next.
Note:
If you want to change the license server after installation, modify the ansyslmd.ini
file in the AnsysEM/shared_files/licensing folder.
The Installing Ansys Electromagnetics screen appears, displaying a progress bar and
status messages as the installation progresses. You can click Cancel at any time to exit
the installation.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
If you receive a message about read-only files, you typically want to overwrite
them with the newer versions.
14. Once the files have all been copied, one of the following messages may appear:
l If you identified the same machine where you installed the Ansys Electromagnetics
software as the license server, then a message appears that informs you that you
must install the Ansys License Manager on this machine.
l If you identified a machine other than where you installed the Ansys Elec-
tromagnetics software as the license server, then a message appears that identifies
that machine as the license server and informs you that you must install the Ansys
License Manager on that machine.
Click OK.
15. When the installation is complete, the Install Complete screen appears.
Click Done to close the installer window and return to the Ansys Electromagnetics Install-
ation Shell window.
16. Optionally, continue to the Install Electromagnetics RSM task or the Install Layout
Integrations for ECAD task.
17. Click Exit when you are done installing software.
<install_dir>/v242/Linux64/scripts/IntegrateWithAnsys24.2.pl.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
To make effective use of the resources allocated to the analysis, the job settings must match the
job requirements. In addition, the cluster configuration and the resources must be allocated to
the job in a way that the products are able to make effective use of the resources.
Note:
For additional information about high performance computing not in this guide, see the
Ansys Electromagnetics HPC Administrator's Guide (HPC_Admin.pdf) in the install-
ation directory's Help folder.
If an analysis is distributed to multiple hosts, then the Ansys Electromagnetics Suite must gen-
erally be installed at the same path on all hosts used for the analysis. This may be a shared net-
work installation that is accessible using the same path on all analysis hosts (such as
//servername/sharename/AnsysEM/v242/Win64).
Alternatively, a separate, local installation on each host may also be used. In the latter case, the
path name of the installation directory (such as /opt/AnsysEM/v242) must be the same on all
hosts, and all installations must include the same service pack or packs.
A distributed analysis that does not use MPI distribution does not need to meet the above require-
ment. Because MPI is used for all distribution types except for variations, MPI will not be used
only for the following cases:
• If the design type does not support the Auto option and does not allow distribution types
other than distribution of variations, then MPI will not be used for distribution. This currently
includes the Circuit Design, Circuit Netlist, Emit, RMxprt, Maxwell Circuit, Twin Builder, and
Mechanical design types.
• If the Auto option is not selected, and no distribution type other than Variations is enabled,
then MPI will not be used.
For these cases, Ansys Electromagnetics Suite may be installed at different locations on dif-
ferent hosts. These locations must be registered with the RSM Service running on each host.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Symbolic links may be used to allow the use of Ansys Electromagnetics Suite installed at dif-
ferent locations on different hosts. To use this approach, a symbolic link should be created on
each host to point to the actual installation directory on that host. All of these symbolic links
should have the same path on each host.
When starting an analysis, a path that is the same on all hosts should be used to launch
ansysedt (for example, /opt/AnsysEM/v242/Linux64/ansysedt) or other AnsysEM applications.
The same path should be used when registering the installation with Ansys Electromagnetics
RSM, if Ansys Electromagnetics RSM is used. This path must be registered with Ansys Elec-
tromagnetics RSM for all analysis hosts, even the "local" host where ansysedt runs.
/dir1a/dir1b/dir1c/AnsysEM/v242/Linux64
/dir2a/dir2b/AnsysEM/v242/Linux64
ln -s /dir1a/dir1b/dir1c/AnsysEM /opt/AnsysEM
ln -s /dir2a/dir2b/AnsysEM /opt/AnsysEM
Note that the links point to the parent directory of the installation directory so that the "Shared
Files" directory is also accessible using the same path on all hosts. The "Shared files" directory
is a "sibling" of the installation directory; it has the same parent directory as the installation dir-
ectory.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
started on one or more hosts. It runs as a daemon. An analysis may be distributed to any of the
hosts where the Remote Simulation Manager is running. RSM is bundled with Ansys Elec-
tromagnetics products.
Alternatively, there are a number of job schedulers available from third parties, such as IBM
Spectrum LSF, Univa Grid Engine, and Altair PBS Professional. Job schedulers (sometimes
called distributed resource management systems, cluster managers, batch systems or dis-
tributed resource managers) provide job queuing, load balancing, resource assignment, and
other management and monitoring capabilities. When a job is submitted to a scheduler, the
product uses the resources allocated to the job to accomplish the analysis.
Users may be able to use job schedulers that are not included in the list of supported job sched-
ulers via custom scheduler integration. The end user, working with Ansys Electromagnetics
products support engineers, will provide an IronPython script or code library to act as an inter-
face between the scheduler and Ansys Electromagnetics products.
Semaphores on Linux
The Linux kernel provides a number of features to facilitate synchronization between threads
and/or processes. Semaphores are one such mechanism. Linux supports two styles of sem-
aphores, System V IPC semaphores and POSIX semaphores. On Linux, Ansys EM software
uses MainWin, which uses System V IPC semaphores. If there are not enough System V IPC
semaphores available, the software may fail to start or terminate due to errors.
System V IPC semaphores are allocated as semaphore arrays. Each array may contain a few or
many semaphores. The Linux kernel limits both how many semaphore arrays can be allocated,
as well as the total number of semaphores that can be created.
Recommended settings
The following kernel semaphore settings are recommended:
l SEMMSL (maximum number of semaphores per semaphore set) = 256
l SEMMNS (system-wide limit on the number of semaphores in all semaphore sets) =
40000
l SEMOPM (maximum number of operations that may be specified in a semop() call) = 32
l SEMMNI (system-wide limit on the number of semaphore identifiers) = 32000
cat /proc/sys/kernel/sem
The semaphore settings are displayed or set in the order: SEMMSL SEMMNS SEMOPM
SEMMNI
Sample output:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
% cat /proc/sys/kernel/sem
This command must be run as a privileged user, e.g., root. This command immediately changes
the kernel limits. Rebooting the machine resets the semaphore limits to the default values.
/usr/bin/ipcs -s
Sample output:
%/usr/bin/ipcs -s
Use the following Linux command to show additional information about the semaphore array
with semid id:
/usr/bin/ipcs -s -i id
Sample output:
%/usr/bin/ipcs -s -i 23887872
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
mode=0664, access_perms=0664
nsems = 2
You can also remove semaphore arrays using the following Linux command, where semid is the
id of the semaphore array to remove:
/usr/bin/ipcrm -s semid
Semaphore arrays should only be removed if they are no longer being used by any processes.
Semaphore Errors
Error messages due to running out of semaphores may look like the following:
If any errors similar to the above are seen, use the linux command cat /proc/sys/ker-
nel/sem to display the semaphore limits, and use the /usr/bin/ipcs -s command to display the
semaphore sets currently in use. To make more semaphore arrays available, use the com-
mands shown above to change the semaphore limits, or to remove semaphore sets that are no
longer in use.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
load balancing or queueing of jobs is provided. The Remote Simulation Manager is not used if
the analysis is run as a job on one of the supported job schedulers. See: Supported Job Sched-
ulers (Page 3-13). RSM is also not used if the analysis is run as a job using custom scheduler
integration with a scheduler that is not supported by default. See: Custom Scheduler Integration
(Page 3-13).
Important:
You should not install RSM on hosts that are managed by a scheduler.
If you use RSM with MPI integration, you must set the environment variable ANSYS_EM_
EXEC_DIR.
Set this variable to the same value with ANSYS_EM_INSTALL_DIR (not the RSM service path).
To ensure the RSM service can accurately locate the essential script files required for MPI integ-
ration, it is necessary to set this variable within the RSM service environment.
The Disable access by remote machines check box, in the RSM Service Options group box
controls access. If this check box is deselected, as is the default setting, remote hosts can dis-
tribute jobs to the local host. If this check box is selected, remote hosts cannot distribute jobs to
the local host.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Installing RSM
To install Ansys Electromagnetics RSM software:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
If you receive an error that InstallShield did not find enough temporary space to
run, set your ISHIELD_TMP environment variable to a different directory. :
2. Click Next.
If you have other Ansys software installed, Ansys recommends using the same installation
directory.
5. Select the System User, or specify a Specific User with administrative privileges. The
selected user will run remote and distributed analyses when no user is specified in the
product interface. Click Next.
7. Click Finish. At the end of the installation, RSM is automatically started as a service on
this machine.
Troubleshooting Installation
If you use RSM, it must be installed on all remote machines. In addition, the product engines
must be registered on RSM. See below.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Both RSM and Ansys Electromagnetics applications can be installed in one central location. You
do not have to install the application on each machine/node. Ansys recommends using the net-
work-based approach.
Network Installation
1. Install all Ansys Electromagnetics products in a network location accessible from all
machines.
2. Install RSM in a network location accessible from all machines.
3. On every machine, configure and start RSM.
4. On one machine, register Ansys Electromagnetics product installations with RSM.
Non-Network Installation
Configuring RSM
Configuring RSM on a Linux Job Management Host for submitting jobs to a cluster is separate
from using RSM to launch solver processes. That is, a single RSM process cannot be used to do
both functions. RSM may run as the root user when used to launch solver processes, but it
should not be run as the root user when used for submission of jobs to a Linux cluster.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
The user who runs RSM determines who launches solver processes.
User running
User who owns/launches solver processes
RSM
Non-root user User running RSM.
root User who requests to solve. If that user does not exist on this machine, the
user who is running RSM.
You must make each installation of RSM aware of each Ansys Electromagnetics product, so that
remote simulation requests are properly routed to the product. For network installations, you
need only to register each Ansys Electromagnetics product once, regardless of the number of
machines. Otherwise, you need to register each Ansys Electromagnetics product on each
machine running RSM.
<installdirectory>/RegisterEngineswithRSM.pl add
For Remote Analysis or Distributed Analsysis, processes may need to be started on multiple
hosts. If Ansys Electronics Desktop needs to start a process on a remote host, the RSM service
is used to start these remote processes. By default, the RSM service listens for socket con-
nections from the Ansys Electronics Desktop on port 32958.
This section describes how to change the port number used by the RSM service.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
To change the port number, both the RSM service and Ansys Electronics Desktop must be con-
figured to use the new port number. The same port number must be used for Ansys Electronics
Desktop and for the RSM service process running on each host used for the analysis.
The RSM service port number is configured in the ansoftrsmservice.cfg configuration file. This
configuration file is located in the platform specific subdirectory of the RSM installation directory.
$begin 'AnsoftCOMDaemon'
$begin 'Default:CommDetails'
$begin 'CommDetails'
'ListenPort'='32958'
$end 'CommDetails'
$end 'Default:CommDetails'
If there are additional lines between the following two lines, then they should not be modified:
$begin 'AnsoftCOMDaemon'
$begin 'Default:CommDetails'
To change the port number, modify the ListenPort setting within the single quotes from 32958 to
the desired port number. The single quotes should not be removed or changed.
For previous versions of the software, the ansoftrsmservice.cfg file may not contain the lines:
$begin 'Default:CommDetails'
$begin 'CommDetails'
'ListenPort'='32958'
$end 'CommDetails'
$end 'Default:CommDetails'
If these lines are not present, then add them to the ansoftrsmservice.cfg file after the first line of
the file, and change the ListenPort to the desired port number. For example, to change the port
number to 32000, the beginning of the ansoftrsmservice.cfg file should look like the following
after the changes:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
$begin 'AnsoftCOMDaemon'
$begin 'Default:CommDetails'
$begin 'CommDetails'
'ListenPort'='32958'
$end 'CommDetails'
$end 'Default:CommDetails'
The port number for connecting to the RSM service is configured using the General Options
window (Tools > Options > General Options). From the left pane, select Remote Analysis to
view RSM Service Options.
Click Change to open the Change Ansoft Service Port dialog box.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Supported job schedulers are listed at the Ansys Platform Support page:
https://www.ansys.com/Solutions/Solutions-by-Role/IT-Professionals/Platform-Support
Versions earlier than the latest tested version indicated may work and may have been tested in
previous versions of the product. Newer versions may also work if backward compatibility is
maintained by the scheduler.
A custom scheduler proxy is usually an IronPython script file that has a class that implements a
specified interface. Functionally, the methods of this class mediate the interactions between
AnsysEM processes and the scheduler. Physically, such a proxy is a small text file, and does not
require to be compiled/linked. This is often the preferred approach, as it is easier to install and
test. The details of this interface and its methods are described elsewhere. Installing a custom
scheduler proxy usually means just adding a .py file under schedulers subdirectory of the
AnsysEM installation directory. By providing a custom scheduler proxy written in IronPython, you
can even override the default scheduler proxy for a supported scheduler.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Note:
IronPython is an implementation of the Python programming language targeting the
.NET runtime. You do not need to install IronPython, as AnsysEM already comes with
IronPython. AnsysEM supports it on both Windows and Linux. For more information,
see the Scripting section of the online help.
Limitations
Implementing your own custom scheduler proxy does not allow use of the job management GUI.
It also does not provide tight-integration of scheduler for MPI-based jobs.
This section describes how to submit and run a small number of test jobs to verify that the
product installation, the cluster configuration, and the MPI installation and configuration are sat-
isfactory for running Ansys Electromagnetics analysis jobs. These tests are not comprehensive,
but successful completion of all of the jobs indicates that the basic requirements for running
Ansys Electromagnetics jobs have been met.
Each of the test jobs should run to completion in a few minutes or less. They should be run in the
order specified, proceeding to the next test only if any problems found in the preceding test have
been addressed.
The test jobs in this section may be submitted to a cluster using the command line or via the Elec-
tronics Desktop job submission GUI. When using the GUI, the software will create a job sub-
mission command line (the bsub command line) from the parameters specified. The options will
be selected to effectively use the resources allocated to the job by the scheduler. Users may spe-
cify a specific queue and/or parallel environment for the job using the GUI. If no parallel envir-
onment is specified, one will be selected automatically. If no queue is specified, the job
submission command will not contain a queue specification, and the scheduler will select a
queue. The state of the Use automatic settings check box and other job submission GUI con-
trols will affect the job submission command options.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
1. Launch Ansys Electronics Desktop on a host that is configured as a submission host for
the cluster.
2. Click Tools > Job Management > Select Scheduler.
3. Use the Select scheduler drop-down menu to select a scheduler. In the Head Node field,
type the name of a computer or click the ellipses (...) button to view a list of accessible com-
puters in the network.
This is a simple job that uses one core on one host. This test uses the Tee.aedt example project,
which is located in the Examples/HFSS/RF Microwave subdirectory of the product installation dir-
ectory. The file Tee.aedt is needed for this test. This test uses Setup1, but it does not use the fre-
quency sweep, Sweep1, so the frequency sweep must be disabled.
Successful completion of this job indicates that the following requirements have been met:
l The job submission host is correctly configured for submitting jobs to the cluster.
l The job user account is authorized to run jobs on the cluster.
l The product installation is accessible from the cluster host allocated to the job.
l The project directory is accessible from the cluster host allocated to the job.
l Communication between different job processes on the cluster host allocated to the job is
not blocked.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
6. Ensure the Product path contains a path that is valid for the cluster execution nodes.
7. In the Analysis Setups area, select Single Setup. Use the drop-down menu to select
TeeModel:Nominal:Setup1.
8. Click the Compute Resources tab to view additional options.
9. Deselect Use automatic settings, and set the following:
l For Method, use the drop-down menu to select Number of Tasks and Cores.
l Set the Total number of tasks to 1.
l Set the Cores per distributed task to 1.
l Ensure that the Limit number of tasks per node to: check box is deselected.
10. Ignore any other settings, and click Preview Submission.
A preview window appears. If no errors are found, the preview should display information
on how the job will be submitted to the cluster. If an error appears, address the error
before continuing. The preview should indicate that only one host is needed for the job. If
this is not the case, review the job resources specified on the Compute Resources tab
and retry. If the job and task parameters are correct, close preview window and continue.
If an error occurs on job submission, address the error before submitting the job again. If
you are prompted for a password, enter it and continue. If possible, monitor the job until it
finishes.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Test #2: Submitting and Running a Non-MPI Job Distributed to Multiple Hosts
This job uses multiple cores distributed to multiple hosts. It does not use MPI. This job will start
on one host, but portions of the analysis will be distributed to the other hosts allocated to the job.
This test uses the Tee.aedt example project, which is located in the Examples/HFSS/RF
Microwave subdirectory of the product installation directory. This test uses Setup1, and it uses
the frequency sweep Sweep1, so frequency sweep must be enabled.
The cluster must have at least two hosts with the same number of cores per host. Let N be the
smallest number of cores per host, such that the cluster contains at least two hosts with N cores
per host. The job will be submitted to run on two hosts with N cores per host, requesting a total of
2 * N cores. For many clusters, selecting N = 4 may be a good choice.
Successful completion of this job indicates that the following additional requirements have been
met:
l A job process on one cluster host allocated to the job is able to use the cluster to start addi-
tional job processes on other cluster hosts allocated to the job.
l Communication between job processes running on different cluster hosts allocated to the
job is not blocked.
6. Ensure the Product path contains a path that is valid for the cluster execution nodes.
7. In the Analysis Setups area, select Single Setup. Use the drop-down menu to select
TeeModel:Nominal:Setup1.
8. Click the Compute Resources tab to view additional options.
9. Deselect Use automatic settings, and set the following:
l For Method, use the drop-down menu to select Number of Tasks and Cores.
l Set the Total number of tasks to 2 * N.
l Set the Cores per distributed task to 1.
l Ensure that the Limit number of tasks per node to: check box is deselected.
l In the Job distribution group box, press the Modify button to access the Job Dis-
tribution dialog box.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
l In the Enable Distribution Types section, deselect the Use defaults check box,
and select only the Frequencies check box.
l In the Distribution levels section, select the Single level only radio button.
l Click OK to close the Job Distribution dialog box.
10. For the schedulers:
l Click the ellipses (...) button to open the Compute Resource Selection Para-
meters dialog box.
l For MinCoresPerNode , select Specify Parameter and set the value to N.
l For MaxCoresPerNode, select Specify Parameter and set the value to N.
l Click OK to close the Compute Resource Selection Parameters dialog box.
11. Ignore any other settings, and click Preview Submission.
A preview window appears. If no errors are found, the preview should display information
on how the job will be submitted to the cluster. If an error appears, address the error
before continuing. This preview should indicate that a total of 2 * N cores are required for
the job, and that N cores will be needed on each host allocated to the job. If this is not the
case, review the job resources specified on the Compute Resources tab and retry. If the
job and task parameters are correct, close the preview window and continue.
If an error occurs on job submission, address the error before submitting the job again. If
you are prompted for a password, enter it and continue. If possible, monitor the job until it
finishes.
If the job fails to complete successfully, check the following items, in addition to the items men-
tioned for the first test:
l The Desktop process will use the cluster to launch processes on the other hosts allocated
to the job. Verify that the cluster configuration allows a job to launch processes on the
other hosts allocated to the job.
l Job processes on different hosts allocated to the job need to communicate. Verify that
communication between these job processes is not blocked.
Test #3: Submitting and Running an MPI Job Distributed to Multiple Hosts
This job uses MPI processes distributed to multiple hosts. This job will start on one host, but por-
tions of the analysis will be distributed to MPI ranks running on the first execution host and ranks
running on other hosts allocated to the job. This test uses the differential_stripline.aedt example
project, which is located in the Examples/HFSS/Transmission Lines subdirectory of the product
installation directory. The file differential_stripline.aedt is needed for this test. This test uses
Setup1, but does not use the frequency sweep, DC_10GHz. The frequency sweep must be dis-
abled.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Determine which MPI Vendor will be used for MPI jobs, Intel MPI or Microsoft MPI. This test
should use the same MPI Vendor that will be used by cluster users. If no MPI Vendor is specified
by the user, then the default MPI Vendor (Microsoft) is used. Intel MPI is denoted by the string
“Intel.” Microsoft MPI is denoted by the string “Microsoft.” If both MPI Vendors may be needed by
cluster users, then this test should be run twice, once with each MPI Vendor specified. Consult
MPI Installation (Page 4-1) to determine whether the MPI provided by the selected MPI Vendor
needs to be installed and to determine how it should be configured.
The cluster must have at least two hosts with the same number of cores per host. Let N be the
smallest number of cores per host, such that the cluster contains at least two hosts with N cores
per host. The job will be submitted to run on two hosts with N cores per host, requesting a total of
2 * N cores.
Successful completion of this job indicates that the following additional requirements have been
met:
l MPI is installed and configured on the cluster hosts.
l User passwords are registered with MPI on the cluster hosts.
l MPI prerequisites are installed on the cluster hosts.
6. Ensure the Product path contains a path that is valid for the cluster execution nodes.
7. In the Analysis Setups area, select Single Setup. Use the drop-down menu to select
Stripline:Nominal:3GHz.
8. Under Analysis Options, set the HFSS/MPIVendor batchoption to the desired MPI
Vendor, either Intel or Microsoft. If this batchoption is not present, click Add to open the
Add Batchoption dialog box. Locate HFSS/MPIVendor in the list, select it, and click
Add.
9. Click the Compute Resources tab to view additional options.
10. Deselect Use automatic settings, and set the following:
l For Method, use the drop-down menu to select Number of Tasks and Cores.
l Set the Total number of tasks to 2 * N.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
A preview window appears. If no errors are found, the preview should display information
on how the job will be submitted to the cluster. If an error appears, address the error
before continuing. This preview should indicate that a total of 2 * N cores are required for
the job, and that N cores will be needed on each host allocated to the job. If this is not the
case, review the job resources specified on the Compute Resources tab and retry. If the
job and task parameters are correct, close the preview window and continue.
If an error occurs on job submission, address the error before submitting the job again. If
you are prompted for a password, enter it and continue. If possible, monitor the job until it
finishes.
If the job fails to complete successfully, in addition to the items mentioned for the first and
second tests, MPI configuration issues may cause job failures. Check the following MPI con-
figuration issues:
l Verify that the correct MPI Vendor (“Intel” or “Microsoft”) is specified using a batchoption
setting in the Submit Job To: dialog box. The controls for specifying batchoptions are loc-
ated on the Analysis Specification tab, under Analysis Options.
l Verify that the specified MPI Vendor is installed (if needed) and configured correctly for
the user submitting the job, as described in MPI Installation (Page 4-1). Pay close atten-
tion to the registration of user passwords because the lack of a cached password when
one is required, or a cached password that is incorrect or out of date (even if no cached
password is required) may cause authentication errors. Note that passwords are cached
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
separately on each cluster host, so a job may have authentication errors on some hosts
but not on other hosts.
As a companion to the scheduler tests above, the sections below describe configuration require-
ments for the following Linux schedulers:
l Altair PBS Professional
l IBM Spectrum LSF
l Univa Grid Engine
For integration with Windows schedulers, consult the Ansys Electromagnetics Suite 2024 R2
Windows Installation Guide.
For integration with third party or custom schedulers, consult the Ansys Electronics online help.
For cluster jobs, ensure the following environment variables are set correctly:
l PBS_CONF
l PBS_SERVER
l PBS_DEFAULT
If the PBSPro configuration file path has been changed from the default (/etc/pbs.conf), the
PBS_CONF environment variable should be set to the correct path.
If the PBS_SERVER parameter in the PBSPro configuration file is not set to the default PBSPro
server name, the PBS_DEFAULT environment variable should be set to the default server
name.
Users who submit parallel jobs using the job submission GUI may select between several dif-
ferent methods for specifying the resources for the job. If the "Number of Nodes and Cores"
option is selected, with the number of tasks determined automatically, Ansys Electromagnetics
software will select nodes with the greatest number of cores per node that meet all job require-
ments. This may not be the best use of resources for non-homogenous clusters (those where
nodes have different configurations).
In some cases, a job may be allocated one or more nodes with many cores per node, even if the
job could run using the same number of nodes with fewer cores per node. To mitigate this issue,
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
create distinct queues for different job sizes, and specify the appropriate queue during job sub-
mission.
If there is a problem connecting to the scheduler when the job submission node is the local node
(where the GUI is running), ensure the following:
l The cluster is up and running normally.
l The local node is configured as a job submission node for the cluster.
l The user running the GUI has permission to submit jobs to the cluster.
l The environment was configured for submission of jobs to the cluster before starting the
product, ansysedt.
Non-distributed Job
If the job fails to complete successfully, check the items above and:
l Verify that the PBS pbsdsh command is able to start the ansoftrsm process on the other
host.
MPI configuration issues may cause job failures. If the job fails to complete successfully, in addi-
tion to the items mentioned for the first and second tests, check the following:
l Verify that the MPI Vendor batchoption is set to "Intel".
l Verify that the RemoteSpawnCommand is specified via a batchoption setting when sub-
mitting the job; otherwise the default, SSH, will be used for the job.
l Verify that the specified MPI Vendor is installed and configured correctly for the user sub-
mitting the job. See: MPI Installation (Page 4-1).
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
This section describes troubleshooting HPC Test Jobs while using the IBM Spectrum LSF sched-
uler.
In order to submit exclusive jobs, users must have access to queues configured for such. If users
need to submit exclusive jobs to a queue, set the queue's EXCLUSIVE property to Y.
Ansys Electromagnetics products allow users to submit jobs for which the user specifies the
"Number of Cores and (Optional) RAM." However, the RAM per core may only be specified if the
LSF cluster is configured with the parameter RESOURCE_RESERVE_PER_SLOT. This para-
meter should be set to allow user to specify the RAM per core for the job.
If there is a problem connecting to the scheduler when the job submission node is the local node
(where the GUI is running), ensure the following:
l The cluster is up and running normally.
l The local node is configured as a job submission node for the cluster.
l The user running the GUI has permission to submit jobs to the cluster.
l The environment was configured for submission of jobs to the cluster before starting the
product, ansysedt.
Non-distributed Job
If the job fails to complete successfully, check the items above and:
l Verify that the LSF blaunch command is able to start the ansoftrsm process on the other
host.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
MPI configuration issues may cause job failures. If the job fails to complete successfully, in addi-
tion to the items mentioned for the first and second tests, check the following:
l Verify that the MPI Vendor batchoption is set to "Intel".
l Verify that the specified MPI Vendor is installed and configured correctly for the user sub-
mitting the job. See: MPI Installation (Page 4-1).
Note:
The information in this section is generally applicable to previous iterations of UGE,
including Sun Grid Engine (SGE) and Oracle Grid Engine (OGE).
Ansys EM parallel batch jobs use the qrsh command to launch engine processes on remote
hosts. If the qrsh command is not working correctly, the parallel job is unable to launch engine
processes on remote hosts. If this problem occurs, the batch log for the job typically includes one
or more error messages indicating that a COM engine was unable to be started on a remote
host.
The qrsh command may be tested by running a simple command on a specified host, such as
qrsh -l hostname=host1 hostname or qrsh -l hostname=host1 ls /tmp, where host1 is the
remote hostname. The first test should echo back the hostname of the remote machine. The
second test should list the contents of the /tmp directory on the remote machine.
Failures are often associated with certain global configuration parameters, listed below with val-
ues that may cause the failures:
l qrsh_command /usr/bin/ssh -t
l rsh_command /usr/bin/ssh -t
l rlogin_command /usr/bin/ssh -t
If these parameter settings are removed, the UGE built-in mechanisms are used for qrsh, rsh,
and rlogin. No problems with the built-in versions have been reported. The qconf -sconf global
command may be used to view these parameter settings, and qconf -mconf may be used to
modify them.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Parallel Environments
For these clusters, no parallel environment is needed to submit a job that is allocated only one
core on one host. A parallel environment is required to submit a job that requires two or more
cores, whether the cores are on the same host or on different hosts. Appropriate parallel envir-
onments should be configured for the cluster to run the types of parallel jobs that the users would
like to run.
Important:
All parallel environments for Ansys Electromagnetics jobs must be configured with the
control_slaves parameter set to TRUE.
If the Use automatic settings check box is not selected, you must also specify the total number
of tasks, T, for the job, and the number of cores per task, C. The allocations must be integers.
The software will then allocate the same number of tasks, N, on each node, where N is determ-
ined by the nodes available for the job and the user-specified queue and/or parallel environment.
A minimum of N * C cores is required per node, so the allocation rule must be an integer that is
equal to or greater than N * C. Note that if the allocation rule is an integer greater than N * C, the
extra cores allocated to the job are not used, leading to less than ideal resource usage. Ansys
recommends configuring multiple parallel environments with different integral allocation rules to
allow a good match of resources needed by the job to the resources allocated to the job.
If the Use automatic settings check box is selected, you can specify the Number of Nodes
and Cores for the job or the Number of Cores and (Optional) RAM for the job.
l For Number of Nodes and Cores, the job is allocated the same number of cores on
each node, and the parallel environment must be an integer. The parallel environment con-
figurations above are recommended.
l For Number of Cores and (Optional) RAM, a parallel environment with any allocation
rule may be used. Ansys recommends that at least one parallel environment with an alloc-
ation rule of $fill_up be provided, as this allows the job to be mostly run on hosts where no
other job is running. An allocation rule of $round_robin may also be useful to allow such
jobs to be distributed across all available hosts.
Some users require or desire the ability to submit jobs to a cluster that have exclusive access to
each host allocated to the job. That is, any host running the job is not available for use by any
other jobs. This may be needed to limit contention for resources that are not tracked by the
cluster, such as network bandwidth. By default, a UGE cluster may not be configured for exclus-
ive jobs. If the cluster configuration includes a complex of type BOOL, with relop EXCL, that is
both consumable and requestable, then this complex may be used to submit exclusive jobs.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
1. If there is no complex configured as per above, use the following command to add a new
complex to the table of complexes:
qconf -mc
This will display the host configuration settings for the specific host.
There may be multiple lines of settings, but the one you must configure is:
complex_values exclusive=TRUE
Submitting an Exclusive Job from the Command Line
When submitting a job using the qsub command, the job will have exclusive access to each host
allocated to the job if the exclusive resource name (“exclusive”) or exclusive resource shortcut
("excl") is included in the resource list specified by the qsub -l option. If the resource list does not
include the exclusive resource name or the exclusive resource shortcut, then the job will not
have exclusive access to each host allocated to the job; other jobs may run on the same host or
hosts at the same time as this job.
Although serial jobs use only one slot, no other jobs will run on the host where this job is running,
even if additional slots are present.
Example qsub command line for exclusive parallel job using eight engines, each using a single
thread of execution:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
None of the hosts allocated to this job will be allowed to run other jobs while this job is running.
Submitting an Exclusive Job using the Job Submission GUI
For jobs submitted to a UGE cluster using the job submission dialog box, the state of the Nodes
are for exclusive usage by this job check box controls whether the job is submitted as an
exclusive job. This check box is located on the Compute Resources tab of the job submission
dialog box. If this check box is selected, the job submission command line will include the exclus-
ive resource option. The resource name does not need to be “exclusive”; any complex of type
BOOL, with relop EXCL, that is both consumable and requestable may be used.
When submitting memory intensive jobs on a UGE cluster, it may be useful to specify a con-
sumable memory limit for the job. If the resource request for the job specifies a consumable limit,
then, while the job is running, the specified resource is not available for other jobs. Jobs requir-
ing the same resource will only be scheduled on a host if the total quantity of the resource on the
host exceeds the sum of the consumable resource needs of the jobs. For non-consumable
resources, the resource requirement for each job is independently compared to the quantity of
the resource available on the host. Consumable resources may be configured as per-slot
resources or as per-job resources.
Consumable memory limits are important for jobs submitted to a UGE cluster with the Use auto-
matic settings check box selected and the user specifying the Number of Cores and
(Optional) RAM for the job. If the RAM per core is specified by the user, then the job submission
command includes a consumable memory resource requirement. If a complex of type MEMORY
is configured to be requestable and consumable (per-slot, rather than per-job), then this com-
plex will be used for the consumable memory resource requirement to meet the RAM per core
requirement specified by the user. If no such complex is configured, then the RAM per core may
not be specified by the user.
Some versions of Grid Engine come with "m_mem_free" and "mem_free" complexes already
configured. If either one or both are configured as a requestable and consumable per-slot
resource, there is no more configuration required. For other grid engine versions, it may be
necessary to configure a complex to use as a memory resource requirement to allow users to
use automatic settings and specify the Number of Cores and RAM for the job.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
l consumable: YES
l default: 0
l urgency: 0
The sconf -sc command may be used to examine the complexes and their configurations.
The sconf -mc command may be used to modify the complexes or their configurations.
In addition to adding the complex to the cluster for the requestable and consumable memory
resource, each host must be configured to specify the limit of this resource. The sconf -sel com-
mand may be used to list the execution hosts of the cluster. The sconf -se hostname command
may be used to examine the configuration of the host with name hostname. The sconf -me
hostname command may be used to modify the configuration of the host with name hostname.
The memory limit should be added to the complex_values for the host. If there is no complex_val-
ues, then the complex_values entry should be added: the value of the m_mem_free complex
must be the same as the amount of memory on the host. For example, if the complex name is
m_mem_free, and the host has 32 GB of memory, then the complex_values of the host con-
figuration should include the specification “m_mem_free=32G”. Different complex values are
separated by commas in the host configuration.
If there is a problem connecting to the scheduler when the job submission node is the local node
(where the GUI is running), ensure the following:
l The cluster is up and running normally.
l The local node is configured as a job submission node for the cluster.
l The user running the GUI has permission to submit jobs to the cluster.
l The environment was configured for submission of jobs to the cluster before starting the
product, ansysedt.
Non-distributed Job
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
If the job fails to complete successfully, check the items above and:
l Verify that the qrsh command is able to start the ansoftrsm process on the other host.
MPI configuration issues may cause job failures. If the job fails to complete successfully, in addi-
tion to the items mentioned for the first and second tests, check the following:
l Verify that the MPI Vendor batchoption is set to "Intel".
l Verify that the RemoteSpawnCommand is specified via a batchoption setting when sub-
mitting the job; otherwise the default, SSH, will be used for the job.
l Verify that the specified MPI Vendor is installed and configured correctly for the user sub-
mitting the job. See: MPI Installation (Page 4-1).
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Important:
Intel MPI is provided in the Ansys Electromagnetics Suite installation. It is not neces-
sary to install MPI on any machine.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
MPI Batchoptions
Several settings can be controlled via batchoptions. See below.
MPI Vendor
Control the MPI Vendor using the following settings.
l 'HFSS/MPIVendor'='Intel'
l 'HFSS 3D Layout/MPIVendor'='Intel'
l 'Icepak/MPIVendor'='Intel'
l 'Maxwell 2D/MPIVendor'='Intel'
l 'Maxwell 3D/MPIVendor'='Intel'
l 'Q3D Extractor/MPIVendor'='Intel'
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
The Scheduler option can only be used for jobs running under an LSF or UGE scheduler and
only if the MPI Vendor is Intel.
ssh-keygen -t rsa
If you are prompted for a password, there is likely an access issue. Diagnose the problem
by running the following:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
l Copy the contents of your local id_rsa.pub file to the authorized_keys file on the
remote machine:
${HOME}/.ssh/authorized_keys'
9. Verify that you can log into the remote node from the local node:
If the command returns 'hi', configuration is complete. If it fails, diagnose the problem by
running:
Troubleshooting MPI
This section contains some frequently asked questions and error messages.
If there is a conflict with the RedHat gnome-shell window manager during installation, replace
gnome-shell via the terminal emulator command shell with “metacity –replace &” and continue
with the installation. After the installation is complete, change “metacity – replace &” back to
“gnome-shell – replace &“.
A set of tests will be run from the current machine to selected machine(s). These include pinging
the computer(s) and checking RSM availability.
This may occur if anything changed in your network configuration. The most common cause is
your login password was changed as part of a periodic update for network security. If the pass-
words were registered for MPI, they need to be updated on all machines every time the login
passwords are changed.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Error Messages
AnsoftRSMService COM Machine
The attempted launch of solvers via MPI failed while connecting to communication pipes. The
probable cause is failure to install the vendor MPI on one or more machines or password authen-
tication failure for MPI during the launch attempt.
Distributing matrix solutions for domains, process mpirun error: Simulation directory creation
failed for one or more MPI solvers. Check access privileges and disk space for the following:
This message means you do not have the correct privilege for the temp directory on one or more
of the remote machines. In many cases the software uses the installation temp directory that is
defined during the installation on the given machine. It is recommended that this directory be set
for Everyone to have full Read/Write privileges on all machines.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
During MPI initialization, you may receive an error like the following:
This most often happens if there is an issue with the host key based authentication. Check the
terminal where you launched the software for a warning like this one:
Manually initiate an ssh connection from your current machine to this host using the exact host-
name as listed in the warning. Answer yes at the prompt to save the host key.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
4. Click Next.
7. Click Next.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
You must have the necessary privileges in the installation path to be able to remove the files and
folders contained there.
cd /<Installation_Path>/AnsysEM
Where <Installation_Path> is the the path to the parent folder of the AnsysEM folder.
2. Type the following command to remove the version-specific folder and all files and sub-
folders it contains:
rm -rf vxxx
Where xxx is the version number to uninstall. For example, v242 is the folder for version
2024 R2.
3. Press Enter.
It may take a few moments to delete all of the files and subfolders.
4. Optionally, remove any shortcut or script you might have created to launch the product just
uninstalled.
Uninstalling RSM
The procedure for uninstalling RSM is the same as the procedure for uninstalling the Elec-
tromagnetics Suite, except for the name of the folder to remove (specifically, rsm).
1. In a terminal window, use the cd command to change to the top-level folder where the
Ansys Electromagnetics product is installed (typically opt/AnsysEM):
cd /<Installation_Path>/AnsysEM
Where <Installation_Path> is the the path to the parent folder of the AnsysEM folder.
2. Type the following command to remove the rsm folder and all files and subfolders it con-
tains:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
rm -rf rsm
3. Press Enter.
It may take a few moments to delete all of the files and subfolders.
4. Optionally, remove any shortcut or script you might have created to launch RSM, unless
you plan on reinstalling it.
cd /<Installation_Path>/AnsysEM
Where <Installation_Path> is the the path to the parent folder of the AnsysEM folder.
2. Type the following command to remove the version-specific folder and all files and sub-
folders it contains:
rm -rf LayoutIntegrationsxx.x
Where xx.x is the version number to uninstall. For example, LayoutIntegrations24.2 is the
folder for version 2024 R2.
3. Press Enter.
It may take a few moments to delete all of the files and subfolders.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
A - Silent Installation
The Ansys Electromagnetics Suite silent installation feature installs the software on your com-
puter with no windows appearing during the installation process. InstallAnywhere suppresses all
dialog boxes, including error messages and informational message boxes.
Note:
l The path to the installer properties file may be either absolute, or relative to the
directory in which the installer resides.
l If an installer properties file is specified and exists, all other command line
options will be ignored.
l If a properties file named installer.properties or setup.exe.properties is in the
same folder as the installer, it is used automatically (overriding all other com-
mand line options), unless -f is used to point to another valid properties file.
l If an installer properties file is specified but does not exist, the default properties
file is used, if present. Otherwise, any specified command line options will be
used or, if omitted, the installer runs using default settings.
l The setup.exe command help displays additional options beyond those listed
here. This list has been condensed to the options that are relevant to installation
of the Ansys Electromagnetics Suite.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Installer Properties
Regardless of which silent installation methods you choose, the following installer properties are
applicable. Specify installer properties only when you wish to deviate from the default value.
<USER_INSTALL_DIR>/
LIBRARY_COMMON_DIR Common libraries folder path
v242/Linux64
<local machine>
LICENSE_SERVER1 Name of 1st or sole license server
(see Note c)
Notes:
a. This is the default value if an existing license configuration is found on the machine.
b. This is the default value if no license configuration is found on the machine.
c. The listed default value applies only if no license configuration is found on the machine.
Otherwise, the default is the value from the existing configuration.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Refer to the supported setup.exe command line options and available installer properties. Pro-
ceed as follows:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
The advantage of this method is that you can automate the installation process but don't have to
be concerned about the installer properties and their syntax. The GUI guides you through the
installation options, and the correct properties are recorded to the response file. However, if you
choose to edit the response file after recording it, you will have to maintain the correct property
names and syntax.
setup.exe -r "<path/name_to_generate_response_file>"
Note:
The -i gui option has been omitted because graphical user interface is the
default installation mode.
Once completed, the *.properties response file will contain information you can use to
install the same product with the same configuration on other machines.
You can change values only to the right of the "=" sign. See: Example Response File (Page A-7).
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
To install the software on other computers, perform the following steps on each machine:
In silent mode, no confirmation windows of any kind are displayed. InstallAnywhere sup-
presses all dialog boxes, including error messages and informational message boxes.
4. A zero (0) exit code is returned to the command window after a successful installation. If a
code other than 0 is encountered, consult the Installer Result Codes table for information
concerning the cause of the failure. Contact Ansys technical support for additional assist-
ance if needed.
Note:
Installations typically fail for one of the following reasons:
l An invalid path was specified.
l Free space is insufficient on the installation drive.
l There were differences in the property sequences between the recorded
response file and the current silent installation. For example, an old
response file is being used for a newer software version (in which prop-
erties have been added or removed), or an additional prompt must be sat-
isfied due to differences in the two computer systems.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Code Description
The installation completed successfully, but one or more of the actions from the
1
installation sequence caused a warning or a non-fatal error.
-1 One or more of the actions from the installation sequence caused a fatal error.
2001 The installation failed the authorization check, may indicate an expired version.
2002 The installation failed a rules check. A rule placed on the installer itself failed.
The installation failed because not enough disk space was detected during the exe-
2004
cution of the Install action.
The installation failed while trying to install on a 64-bit Windows system, but install-
2005
ation did not include support for 64-bit Windows systems.
The installation failed because it was launched in a UI mode that is not supported
2006
by this installer.
Indicates that the user attempted to launch multiple instances of an installer at the
2009
same time even though the installer was configured to prevent multiple launches.
3001 The installation failed due to an error specific to the lax.main.class property.
3002 The installation failed due to an error specific to the lax.main.method property.
The installation was unable to access the method specified in the lax.main.method
3003
property.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Code Description
A Java executable file could not be found at the directory that was specified by the
4000
java.home system property.
4001 An incorrect path to the installer jar caused the relauncher to launch incorrectly.
Modification of existing instance failed because the instance has not been unin-
5000
stalled properly or because the product registry has been corrupted.
The upgrade was canceled because a newer version of the product is already
8000
installed on the target system.
The upgrade exited because the earlier version of the product could not be suc-
8002
cessfully uninstalled.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
############################################################################
#
# ANSYS Electromagnetics Install Location
#
# Specify a valid directory into which the product should be installed.
# If the directory contains spaces, enclose it in double-quotes.
# Example: To install the product to /home/user/My Product, use:
#
# USER_INSTALL_DIR="/home/user/My Product"
#
# Choose Install Folder
# ---------------------
USER_INSTALL_DIR=/tmp/AnsysEM
############################################################################
#
# Temporary Path
#
# Specify directory to be used by default for temporary files. The
# Temp directory is used during local and remote simulations for temporary
# workspace. Users may configure a different temp directory from this
# installation default. This folder will be used during local and/or
# remote simulations as temporary work space. If the path contains
# spaces, enclose it in double-quotes.
#
# Select Temporary Directory
# --------------------------
TMP_DIR=/scratch
############################################################################
#
# Temporary Folder Permissions
#
# If multiple users will run simulations from this installation, they need
# read/write permissions on the Temp directory.
# Changes permissions to 777 on temporary directory by setting TMP_RW=1.
# Changes permissions to 755 on temporary directory by setting TMP_RW=0.
#
TMP_RW=1
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
############################################################################
#
# Library Option
#
# Select whether new users should use a common library location by default.
# This product supports the common libraries installation, a centralized
# installation of materials, components, and other libraries used in Ansys
# Electromagnetics products. You may also add custom materials that are
# automatically accessible to all users and products that use this common
# library installation.
#
# This is the state of the library option radio buttons.
# Selecting Install Libraries:
# LIBRARY_LOCAL_INSTALL = 1 and LIBRARY_COMMON_INSTALL=0
# To Use Existing Libraries:
# LIBRARY_LOCAL_INSTALL = 0 and LIBRARY_COMMON_INSTALL=1
#
# Choose Library Option
# ---------------------
LIBRARY_LOCAL_INSTALL=1
LIBRARY_COMMON_INSTALL=0
############################################################################
#
# Library Path
#
# This is the path for which the client will retrieve material libraries.
# This path should point to the default libraries installed with the client,
# or pointto a location of libraries installed in a common shared network
# location. If the path contains spaces, enclose it in double-quotes.
#
LIBRARY_COMMON_DIR=
############################################################################
#
# License Configuration Option
#
# Here the option is specified where licenses for this software will be
# served. This is the state of the license option radio buttons. Valid
# entries are:
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
#
# To specify license server:
#
# SPECIFY_LIC_CFG=1 and KEEP_LIC_CFG=0
# To keep the current license configuration:
# SPECIFY_LIC_CFG=0 and KEEP_LIC_CFG=1
#
# License Information
# -------------------
SPECIFY_LIC_CFG=1
KEEP_LIC_CFG=0
############################################################################
#
# Client license server name (1)
#
# This is the machine name for the client license server. There can only be
# one single server, or three redundant servers.
#
LICENSE_SERVER1=pitrh6licsrv1
############################################################################
#
# REDUNDANT SERVERS
#
# If SPECIFY_LIC_CFG=1 and you also want to specify the redundant license
# servers, set: REDUNDANT_SERVERS=1
#
REDUNDANT_SERVERS=0
############################################################################
#
# Client license server name (2)
#
# This is the machine name for the second of three client license servers.
# There can only be one single server, or three redundant servers.
#
LICENSE_SERVER2=
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
############################################################################
#
# Client license server name (3)
#
# This is the machine name for the third of three client license servers.
# Therec an only be one single server, or three redundant servers.
#
LICENSE_SERVER3=
############################################################################
#
# TCP/IP Port
#
# This is the TCP/IP port used to communicate with the license server.
# To specify port: SPECIFY_PORT=1 and modify LICENSE_PORT according to
# the desired value. By default, LICENSE_PORT is set to 1055
#
SPECIFY_PORT=0
LICENSE_PORT=1055
############################################################################
#
# The value "Yes" in this Install part should not be modified and left as
# it is for a successful install. The path of ".CreateSymlinks.bash" must
# be modified to the valid installation path on the target machine.
# For example: /tmp/AnsysEM will be replaced by the value as specified
# for USER_INSTALL_DIR
#
# Install
# -------
-fileOverwrite_/tmp/AnsysEM/v242/Linux64/scripts/.CreateSymlinks.bash=Yes
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
B - License hostids
Software licenses for each module of Ansys Electromagnetics products you purchased are con-
tained in one or more license files provided by Ansys. Each license file requires one or more
license hostids, which are physical devices that contain a unique identification. License hostids
are always required for the license server, and they may also be required for each machine run-
ning Ansys software.
The following sections describe the process for obtaining valid hostids.
hostid
You can obtain an ethernet address to use as a valid license hostid. The method for doing so dif-
fers depending on whether you are running Windows or Red Hat Enterprise Linux.
To obtain an ethernet address as a valid license hostid when running Microsoft Windows:
1. If you are using a docked laptop, disconnect it from the docking station.
2. From the terminal, type the following:
ifconfig
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
3. Press Enter.
Devices with an ethernet address show a Link encap value of Ethernet. The ethernet
address for each device is the value in the HWaddr field, without colons.
A Flexera FLEXid hardware key may be provided to you by Ansys. The license hostid of a hard-
ware key is affixed to the hardware key itself. The hostid is a 17- to 21-character value that
begins with FLEXID=. Only a single device can be installed on each USB port.
Consult Ansys License Manager documentation for instructions on using USB dongles:
https://www.ansys.com/it-solutions/licensing
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
l For Linux, you must set this environment variable manually. For example:
/opt/AnsysEM/v242/Linux64
Note: The environment variable must be set on all hosts if the analysis is distributed to
multiple hosts. For Linux, the user must ensure that the environment variable is set for
the AnsoftRSM Service daemon processes.
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
Index
analysis
installing 2-1
Ansys Workbench
options 3-2
hostid B-1
installation
prerequisites 1-1
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
licensing
hostid B-1
Maxwell
notes 4-2
configuring 3-9
installing 3-7
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
schedulers
configuring 3-21
custom 3-13
testing 3-21
software
installing 2-1
uninstalling 6-1
TCP/IP 1-2
Ansys Electromagnetics Suite 2024 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential