Screenshot 2023-05-11 at 14.51.42
Screenshot 2023-05-11 at 14.51.42
Screenshot 2023-05-11 at 14.51.42
1
Installation and Operations Guide
Americas Europe, Middle East, Africa
5161 California Ave, Suite 200 Am Moosfeld 13
University Research Park 81829 Munich, Germany
Irvine, CA 92617 Telephone: (49) 89 431 98 70
Telephone: (714) 540-8900 Email: info.europe@hexagon.com
Email: americas.contact@hexagon.com
Japan Asia-Pacific
KANDA SQUARE 16F 100 Beach Road
2-2-1 Kanda Nishikicho, Chiyoda-ku #16-05 Shaw Tower
Tokyo 101-0054, Japan Singapore 189702
Telephone: (81)(3) 6275 0870 Telephone: 65-6272-0082
Email: MSCJ.Market@hexagon.com Email: APAC.Contact@hexagon.com
Worldwide Web
www.mscsoftware.com, www.hexagon.com
Support
https://simcompanion.hexagon.com/
Disclaimer
This documentation, as well as the software described in it, is furnished under license and may be used only in accordance with the
terms of such license.
Hexagon reserves the right to make changes in specifications and other information contained in this document without prior notice.
The concepts, methods, and examples presented in this text are for illustrative and educational purposes only, and are not intended
to be exhaustive or to apply to any particular engineering problem or design. Hexagon assumes no liability or responsibility to any
person or company for direct or indirect damages resulting from the use of any information contained herein.
User Documentation: Copyright © 2023 Hexagon AB and/or its subsidiaries. All Rights Reserved.
This notice shall be marked on any reproduction of this documentation, in whole or in part. Any reproduction or distribution of this
document, in whole or in part, without the prior written consent of Hexagon is prohibited.
This software may contain certain third-party software that is protected by copyright and licensed from third party licensors. Additional
terms and conditions and/or notices may apply for certain third party software. Such additional third party software terms and
conditions and/or notices may be set forth in documentation and/or at Third party software information (or successor website designated
by Hexagon from time to time). Portions of this software are owned by Siemens Product Lifecycle Management, Inc. © Copyright 2023.
The Hexagon logo, Hexagon, MSC, MSC Adams, MD Adams, and Adams are trademarks or registered trademarks of Hexagon AB
and/or its subsidiaries in the United States and/or other countries. FLEXlm and FlexNet Publisher are trademarks or registered
trademarks of Flexera Software. Parasolid is a registered trademark of Siemens Product Lifecycle Management, Inc. All other
trademarks are the property of their respective owners.
ADAM:V2023.1:Z:Z:Z:DC-OPS-PDF
Documentation Feedback
At Hexagon Manufacturing Intelligence, we strive to produce the highest quality documentation and
welcome your feedback. If you have comments or suggestions about our documentation, write to us.
Please include the following information with your feedback:
Document name
Release/Version number
Chapter/Section name
Topic title (for Online Help)
Brief description of the content (for example, incomplete/incorrect information, grammatical
errors, information that requires clarification or more details and so on).
Your suggestions for correcting/improving documentation
You may also provide your feedback about Hexagon Manufacturing Intelligence documentation by
taking a short 5-minute survey.
Note: The above mentioned e-mail address is only for providing documentation specific
feedback. If you have any technical problems, issues, or queries, please contact Technical
Support.
Contents
Adams 2023.1 Installation and Operations Guide
Preface
About Hexagon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Internet Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
1 Getting Started
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Welcome to Adams Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
What You Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Types of Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Product Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Licensing on Linux
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
About the Adams License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Licensing Adams When File and License Server Are Same Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Licensing Adams When File and License Server Are Different Systems. . . . . . . . . . . . . . . . . . . . . . . . . . 41
Starting the Adams License Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Restarting the Adams License Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Changing the License to Point to a Different License Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Verifying a Successful License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6 Licensing on Windows
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Licensing Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Specifying your License. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Replacing Codes (Licenses) on an Existing Windows Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Customizing End-User License Administration ............................................. 70
9 Troubleshooting
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Troubleshooting on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Troubleshooting on Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Preface
About Hexagon
Technical Support
Internet Resources
x Adams 2023.1 Installation and Operations Guide
About Hexagon
About Hexagon
Overview
Hexagon is the leading global provider of virtual product development (VPD) tools, including simulation
software and professional services. Hexagon helps companies make money, save time, and reduce costs
associated with designing, testing, producing, and supporting manufactured products.
Hexagon works with thousands of companies worldwide, in hundreds of industries, to develop better
products faster by using information technology, software, and services to enhance and automate the product
design and manufacturing process. Simulating your product performance reduces development costs, time to
market, and warranty costs.
Technical Support
For help with installing or using an Hexagon product, contact Hexagon technical support. Our technical
support provides technical assistance on questions related to installation and use of the software. For further
details please see the Technical Support Usage Guide, which is accessible via our support web site.
You can reach Hexagon technical support on the web, by telephone, or e-mail.
CHAPTER xi
Preface
Web
Go to the Hexagon web site at www.hexagon.com, scroll down and click on Services & Training Here, you
can find a wide variety of support resources including Product Updates, Discussions, Technical Articles, and
Documentation updates.
In addition, we provide several excellent sources of online information:
SimCompanion: Find solutions to problems in this repository of troubleshooting tips, examples,
and frequently asked questions. To access the SimCompanion, go to:
https://simcompanion.hexagon.com/
VPD Community: The VPD community is where to go when you are looking for peer support, as
well as technical expertise. Many of our consultants, developers, and technical support staff monitor
the forums. To sign up for the forums, go to Adams Support Home Page.
Then,
• To view the Adams discussions, select Adams from the Forums menu.
• To view product alerts and company news and events, select Product Updates.
Training
Hexagon training provides comprehensive training in Virtual Product Development. We offer standard and
customized training courses in the application of CAE tools to solve from basic to complex problems within
any industry. We offer over 100 courses in our state-of-the-art classroom facilities and individual computer
graphics laboratories at training centers throughout the world. All of our courses emphasize hands-on
computer laboratory work to facilitate skills development. We are uniquely positioned to optimize your
investment in design and simulation software tools.
xii Adams 2023.1 Installation and Operations Guide
Internet Resources
Our industry experienced expert staff is available to customize our course offerings to meet your unique
training requirements. For the most effective training, we also offer many of our courses at our customer's
facilities.
We specialize in customized training based on our evaluation of your design and simulation processes, which
yields courses that are geared to your business. In addition to traditional instructor-led classes, we also offer
video courses, interactive multimedia training, web-based training, and a specialized instructor's program.
Internet Resources
Hexagon (www.Hexagon.com)
Hexagon corporate site with information on the latest events, products and services for the CAD/CAE/CAM
marketplace.
MSC Nastran Implicit Nonlinear (SOL 600) User’s GuideAdams 2018 Installation and Oper-
ations Guide
Chapter 1: Getting Started
1 Getting Started
Overview
Welcome to Adams Products
What You Need
Types of Installations
Product Categories
Getting Help
2 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter describes what you need to know and have available to install the Adams 2023.1 suite of
software. It contains the sections:
Welcome to Adams Products, 3
What You Need, 4
Types of Installations, 5
Product Categories, 6
Getting Help, 7
CHAPTER 1 3
Getting Started
Types of Installations
The way in which you install and license the Adams products depends on your installation configuration.
Any given installation configuration is composed of the following three components:
File server - Machine that contains the Adams files. It may be shared with other computers on a
network.
License Server - Machine that runs the Adams license server. The licensing of Adams products
depends on the type of license you purchased.
Client - Machine that runs the Adams products.
You can manage these three components on one machine, three different machines, or any combination of
machines. You can also install Adams products on a heterogeneous network where you install Adams
products for different platforms all on one network. For information on the various Linux configurations,
see Linux Installation Roadmaps, 99.
6 Adams 2023.1 Installation and Operations Guide
Product Categories
Product Categories
The product(s) or feature package you are licensed to use for Adams appear on the first page of your password
certificate under the section Feature/Password. When you install the products, select the packages that you
are licensed for.
CHAPTER 1 7
Getting Started
Getting Help
If you have questions or problems installing or testing your Adams products, refer to Troubleshooting, 91. If the
problems persist, go to the Technical Articles or Known Issues at http://simcompanion.hexagon.com/. If the
problems still persist, call Hexagon Technical Support. For a current list of phone numbers and language-
based email addresses please visit our web site http://www.hexagon.com, scroll down and click on Services
Technical Support (SimCompanion), on the SimCompanion webpage select Support Support Contact
Information. Before contacting Technical Support, please have the following information available:
Hardware type (be as specific as possible)
Version of the operating system, including build number and service packs, if applicable
Version of compilers
Hardcopy of all error messages (you can send it by fax or through e-mail)
If possible, generate a troubleshooting report as explained in Generating Problem Reports, 93.
MSC Nastran Implicit Nonlinear (SOL 600) User’s GuideAdams 2017 Installation and
Operations Guide
Chapter 2: Hardware and Software Configurations
Overview
Hardware and Software Specifications
Compiler Requirement Details
System Requirements
Graphics Requirements
Licensing Requirements
Dropped Platforms
10 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter provides the hardware and software configurations for Adams.
Note: For the latest version of the hardware and software specifications, see the Adams Support site
at http://simcompanion.hexagon.com
Notes: 1. Intel IA-32 and x64 processors: Pentium (4, D), Core (i3, i5, i7), Xeon and AMD compatibles.
2. Adams 2023.1 product developed using the 'Intel Composer Edition' compiler.
3. Adams Controls is supported on these platforms. However, partner product support varies. Please
see the Supported Versions of Integration Products section of the Adams product Release Guide.
4. Conditions under which compilers are required are listed below in Compiler Requirement Details
section.
5. For the latest information on supported platforms for upcoming releases of MSC products, please
visit the following web site: http://www.hexagon.com/platform-support/
6. Adams officially supports the Professional Edition of Microsoft Visual Studio, but the Community
Edition has been found to function in the following scenarios:
• DLL generation for user-written subroutines in C or in C and Fortran
• Some Adams Controls scenarios with MATLAB/Simulink, Easy5 and FMI compliant
software. For details, please see the Supported Versions of Integration Products section of the
Adams product Release Guide.
The required compiler versions for this version of Adams are found in the Hardware and Software
Specifications section. The conditions under which compilers are required and any deviations to the generally
required versions are listed below:
*
Easy5 requires Intel® Fortran
**
Easy5 requires GNU Compiler Collection or Intel® Fortran; Intel® recommended
^
Easy5 requires Visual Studio linker; note that some FORTRAN compiler environments include this
#MATLAB/Simulink® may require it under some circumstances; check with The MathWorks, Inc. for
compiler requirements
##
MATLAB/Simulink® requires it for building the .dll to be exported; check with The MathWorks, Inc. for
compiler requirements
$
FMI with Easy5 requires GNU Compiler Collection or Intel® compiler
$$
FMI with Easy5 requires GNU Compiler Collection or Visual Studio C compiler
14 Adams 2023.1 Installation and Operations Guide
Hardware and Software Specifications
*
Easy5 requires Intel® Fortran
**
Easy5 requires GNU Compiler Collection or Intel® Fortran; Intel® recommended
#
MATLAB/Simulink® may require it under some circumstances; check with The MathWorks, Inc. for
compiler requirements
##MATLAB/Simulink® requires it for building the .dll to be exported; check with The MathWorks, Inc. for
compiler requirements
$
FMI with Easy5 requires GNU Compiler Collection or Intel® compiler
CHAPTER 2 15
Hardware and Software Configurations
System Requirements
Table 2-4 shows the system requirements for Adams.
Notes: Ubuntu Linux 20 and 22.04 are also supported, but only for standalone Adams
Solver jobs including those that use Adams Controls and/or Adams Car Solver
extensions.
The CSH shell is required for the installation and use of Adams on Ubuntu. Using
another shell, such as bash, will result in unexpected behaviour.
16 Adams 2023.1 Installation and Operations Guide
Graphics Requirements
Graphics Requirements
The following are the graphics requirements for Adams.
Licensing Requirements
Following are the Adams licensing requirements for obtaining a node locked license file. Note that when
obtaining licenses from a server, this version of Adams requires access to MSC License Server (FLEXlm)
v11.13 or greater (installed separately).
Dropped Platforms
Each release we review the platforms and operating system changes by our partners and in the industry, and
address these changes in our release. We make this information available to you for hardware planning. We
welcome your input on platform support. Please communicate platform support needs to your MSC Sales
Representative.
MSC Nastran Implicit Nonlinear (SOL 600) User’s GuideAdams 2018 Installation and Oper-
ations Guide
Chapter 3: Installing Adams on Linux
Overview
Preparing to Install the Adams Product
Creating the Installation Directory
Installing Adams
Installing the Adams Controls Thin Client
Installing the Adams Extension for Easy5
Installing on a Heterogeneous Network
20 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter provides instructions for installing the Adams software. It contains the sections:
Preparing to Install the Adams Product, 21
Creating the Installation Directory, 22
Installing Adams, 23
Installing the Adams Controls Thin Client, 32
Installing the Adams Extension for Easy5, 33
Installing on a Heterogeneous Network, 35
After installing the Adams products, you need to set up the licenses to run them. See Licensing on Linux, 37 for
more information.
Note: For general steps (roadmaps) for the various Linux configurations, see Linux Installation
Roadmaps, 99
CHAPTER 3 21
Installing Adams on Linux
Note: Installers always copy to the /tmp location, if the /tmp partition is too small, it is not
possible to run the product on the machine. It is recommended to set the environmental
variable ‘HMI_TMP_DIR=/file_location’ which changes the default location for
extracting installer files to the specified directory.
HMI_TMP_DIR=/scratch - Executing this variable will extract the files to scratch folder
22 Adams 2023.1 Installation and Operations Guide
Creating the Installation Directory
Installing Adams
This section contains instructions for starting the Adams installation program.
After downloading Adams from the Software Download Center (SDC), you will run the installation program
from the directory you unloaded the executable installer into.
Note: The CSH shell is required for the installation and use of Adams on Ubuntu. Using another
shell, such as bash, will result in unexpected behavior.
The installation program has command line options available to help you tailor the installation to your site's
needs.
Running the installation program without any options will launch it in graphical mode. Running in
graphical mode uses the X-Windows display protocol. You must have the X-Windows DISPLAY variable set
to a valid display to run in graphical mode.
Available Options:
--help Display this information
-i s Set this mode to run the installer in Silent installation mode.
Use -s along with silent file name
-i console Set this mode to if you want to install Adams through console mode by
manually entering required input via Linux console without GUI install
shield display
The installation responses are often system specific, it is not recommended to use the responses from one
platform installer on other supported platforms.
The most common combinations are provided as examples below because Hexagon changes the name of the
installation program to include product and release version number. The generic name "installer.bin" is used
to represent the name of the installer in these examples.
The installation program will install in graphical mode by default.
1. Move to the installation directory you previously created.
2. Locate the installation program, adams_XXXXXX_PLAT.bin, in the download directory. The full
path to the installation program will be needed to run it.
where XXXXXX is the release version, and PLAT is the platform name that corresponds to the
platform you wish to install. For example:
adams_2023_1_linux64_rhe79.bin
3. Start the installation program, the welcome agreement window will appear as shown below.
24 Adams 2023.1 Installation and Operations Guide
Installing Adams
4. Select Acknowledged > button to continue, or Cancel button to exit without installing.
5. Select the full path to the directory you want to install Adams in. You can type in the directory path
after selecting the Browse button, or use the directory tree to locate the installation directory.
CHAPTER 3 25
Installing Adams on Linux
7. Select the Next > button to confirm your installation selection (s). A progress dialog box will be
displayed. You can select the Cancel button at any time to stop the installation.
CHAPTER 3 27
Installing Adams on Linux
8. You must select your HTML Browser that will be used to access all documentation that you have
installed. You can type in the full path after selecting the Browse button, or use the directory tree to
locate the browser.
28 Adams 2023.1 Installation and Operations Guide
Installing Adams
9. The Licensing dialog box allows you to choose the method of communications with an Hexagon
License Manager. The most common method for communicating with the license manager is a
port@host connection. This is the TCP port number your license manager is listening to, and the
hostname of the system that is running the license manager processes. The standard Hexagon License
ManagerTCP port number is 27500.
CHAPTER 3 29
Installing Adams on Linux
11. If you chose to install either the Adams package or the Adams Advanced package, you will need to
setup the Adams Extension for Easy5. For more information, refer to Installing the Adams Extension for
Easy5, 33
Other than the default standard installation, you will encounter various installation scenarios. The following
lists the common standard scenarios used in Adams.
Scenario 1:
Linux typically involves running the installer without any user intervention or interaction. If you want to
install Adams using the silent installation option, then in command-line use “-s” along with silent file name
installer.bin -s auto_instal.xml
The silent installation process should start and run without any user intervention.
CHAPTER 3 31
Installing Adams on Linux
Note: The file auto_instal.xml can be generated after you select Generate an automatic
installation Script option at the end installation. See Step 10.
Scenario 2:
You have tried to install, but the installer reports that it does not have enough file system space to create
temporary files during the installation. If you are facing space issue in /tmp directory, you can change
extraction location for installer files using environment variable.
Set HMI_TMP_DIR to directory of your choice.
Example: export HMI_TMP_DIR=/root/testing
Scenario 3:
You are installing on a system that does not have a system console running an X-Windows server. If you want
install Adams through console mode by manually entering required input via Linux console without GUI
install shield display.
installer.bin -i console
The -i console mode will use text prompts to answer the questions required to install. You can use -i console
mode with all other options.
32 Adams 2023.1 Installation and Operations Guide
Installing the Adams Controls Thin Client
Note: You must install the Adams Extension for Easy5 to use the Adams Controls Thin Client with
Easy5. For more information, see Installing the Adams Extension for Easy5, 33.
CHAPTER 3 33
Installing Adams on Linux
To run Adams and Easy5 together, you must install the Adams extension into Easy5. To import models into
Adams that were exported from Easy5 (containing components from licensed Easy5 libraries), you must also
configure your computer so that Adams knows how to find your Easy5 license. The following procedures
explain how to do this.
Note: If you are unable to identify a command line command to run Adams but you can
identify the top-level directory of the Adams installation, you can use -d
directory_path in place of the command line command in the following steps.
To configure your computer to run licensed exported Easy5 models within Adams:
1. Start Easy5.
2. From the File menu, select Open Command Shell.
3. At the prompt in the command shell, type easy5x --license.
34 Adams 2023.1 Installation and Operations Guide
Installing the Adams Extension for Easy5
Easy5 displays the licensing information, beginning with the type of license and the server name (if a
server license) or the path to the license file.
4. Write down the contents of the line that starts with Active license file(s), and the value that appears
in the line following it (for example, 27500@rainier).
5. Perform one of the following:
• If the line is Active license file(s) [EASY5_LMD_LICENSE_FILE], set the environment variable
EASY5_LMD_LICENSE_FILE to the output value displayed in Step 4 above (for example,
27500@rainier).
• If the line is Active license file(s) [MSC_LICENSE_FILE], find the value of the environment
variable MSC_LICENSE_FILE to see what license file Adams is using.
• If Easy5 and Adams are using different licenses (or license servers), set LM_LICENSE_FILE to
the value for the Easy5 license (for example 2500@bosco).
• If Easy5 and Adams are using the same license, your computer is configured properly.
CHAPTER 3 35
Installing Adams on Linux
4 Licensing on Linux
Overview
About the Adams License Server
Licensing Adams When File and License Server Are Same Machine
Licensing Adams When File and License Server Are Different Systems
Starting the Adams License Server
Restarting the Adams License Daemons
Changing the License to Point to a Different License Server
Verifying a Successful License
38 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter provides instructions for licensing the Adams software. You must complete the steps in Installing
Adams on Linux, 19 before licensing the Adams software. Refer to Linux Installation Roadmaps, 99 for which
procedure in this chapter to follow depending on your system configuration.
The chapter contains the sections:
About the Adams License Server, 39
Licensing Adams When File and License Server Are Same Machine, 40
Licensing Adams When File and License Server Are Different Systems, 41
Starting the Adams License Server, 42
Restarting the Adams License Daemons, 43
Changing the License to Point to a Different License Server, 44
Verifying a Successful License, 45
CHAPTER 4 39
Licensing on Linux
To set up licensing:
1. From the Installation directory start the installation program INSTALL.ADAMS.
2. Enter 1 to select the option, Install Adams passwords on this license server.
3. Enter y if the name of the Adams license server that appears in the prompt is the same as the machine
designated as the server in your e-mail password certificate. (Depending on the type of license you
have, the server name may not be listed in your e-mail certificate; in this case, use the hostid instead.)
4. The default is the machine to which you are logged on. If this is not your license server, enter n, log
in to your license server, and start the procedure again.
5. Follow the instructions in the e-mail password certificate to locate the information required for
licensing your Adams software.
6. At the prompt Are your passwords in a file e-mailed from MSC Software?, enter y.
7. Enter the name of the text file that contains your passwords.
The installation program reads this file and constructs a properly formatted license data file
(license.dat) for you.
8. If the installation program cannot read the file, open the original file and verify that you cut the
information required for licensing at the correct locations.
9. Continue with Starting the Adams License Server, 42.
CHAPTER 4 41
Licensing on Linux
Note: To add the Adams license server startup commands, follow the instructions provided by your
operating system.
The licensing of Adams products is complete. You can now verify that installation was successful by following
the procedures in Verifying a Successful License, 45.
44 Adams 2023.1 Installation and Operations Guide
Changing the License to Point to a Different License Server
5 Installing Adams on
Windows
Overview
Installing the Adams Controls Thin Client
Installing the Adams Extension for Easy5
Installing Adams in Silent Mode (Batch)
48 Adams 2023.1 Installation and Operations Guide
Overview
Overview
The following sections explain how to install Adams 2023.1 products and online documentation by running
the Adams 2023.1 installation program. It also includes information on licensing your Adams 2023.1.
Installing Adams, 48
Installing the Adams Controls Thin Client, 59
Installing Adams in Silent Mode (Batch), 63
Installing Adams
This section shows you how to install Adams software and documentation.
To install Adams:
1. Open Windows Explorer, browse to your Adams download and double click the Adams 2023.1 self
extracting executable file.
The language selection window will appear as shown below:
2. If you select “English” the welcome agreement window will appear as shown below.
3. If you select “Japanese” the welcome agreement window will appear as shown below.
Note: To re-select the language, click Cancel button to exit and restart the installation.
5. In the Customer Information window, enter your user and company name, and then select one of
the following:
• Anyone who uses this computer (all users) - Anyone logged on to this machine can run Adams
2023.1.
• Only for me - A user must be logged on using the user name and password that was used at the
time of installation.
52 Adams 2023.1 Installation and Operations Guide
Overview
6. Select Next.
The Setup Type window appears as shown below. Browse to the desired installation folder location.
Note: Installation paths on drives other than the C:\ and including spaces are unsupported.
The installation will proceed, but Adams will fail to launch. If Destination Folder is
on a drive other than C:\ do not select a path with a space in it.
Note: You cannot install the Adams Controls Thin Client at the same time as other Adams
2023.1 products. You must install it by itself. See Installing the Adams Controls Thin Client,
59 for more information
11. Confirm the installation settings and then select Next to begin the installation.
12. The License Setup window appears as shown below.
CHAPTER 5 55
Installing Adams on Windows
13. Enter the name of the license server or the path to your license file. If you don’t enter this information
here, you can specify your license using the procedure in Specifying your License, 68.
14. Select Next.
15. Specify whether or not you want to install the various desktop icons. If you select Yes, then select the
products for which the icons to be created.
56 Adams 2023.1 Installation and Operations Guide
Overview
17. Select the solver product with which you want .acf files on this machine associated. You can also select
not to associate .acf files with an Adams 2023.1 product.
18. Select Next.
A dialog box appears indicating that the file permissions are being changed. If you do not have
sufficient administration privileges you need to contact the system administrator.
19. Select Next.
If you do not have the Visual Studio Redistributable Package installed, the installer begins the
installation of the following packages:
• Microsoft VC++ 2017 x64 redist – 14.12.25810
• Microsoft VC++ 2019 x64 redist – 14.24.28127
• Microsoft VC++ 2022 x64 redist – 14.32.31326.0
20. To view the readme file, select I would like to view the README file.
58 Adams 2023.1 Installation and Operations Guide
Overview
Note: You must install the Adams Extension for Easy5 to use the Adams Controls Thin Client.
60 Adams 2023.1 Installation and Operations Guide
Installing the Adams Extension for Easy5
To run Adams and Easy5 together, you must install the Adams extension into Easy5. To import models into
Adams that were exported from Easy5 (containing components from licensed Easy5 libraries), you must also
configure your computer so that Adams knows how to find your Easy5 license. The following procedures
explain how to do this.
Note: Check https://help.hexagonmi.com/ to find the versions of Easy5 that are compatible with
Adams. Select the current version, for example Adams 2023.1 - Online Help (HTML) and
go to Release Guide -> Supported Versions of Integration Products.
Installation of the Adams Controls Extension is performed automatically during the Easy5 installation
process if Adams is previously installed, and you answer "Yes" to the installer prompt asking you to install this
component.
To manually install the Adams Controls Extension:
1. Make sure that both Easy5 and Adams have been installed.
2. Make sure you have permission to add and modify files in the Easy5 installation directory. You need
administrator privileges if the installation directory is located in "C:\Program Files".
3. Perform the following (As an administrator if Easy5 is installed in "C:\Program Files"):
a. From the Start menu, point to Programs, point to Easy5 <version> and then left-click on Easy5
to launch Easy5.
Note: To run Easy5 as Administrator, right-click on Easy5 and in the menu that pops
up, under "More", select "Run as administrator". This will launch Easy5 as
Administrator.
To configure your computer to run licensed exported Easy5 models within Adams:
1. Start Easy5.
2. From the File menu, select Open Command Shell.
3. At the prompt in the command shell, type easy5x -license.
Easy5 displays the licensing information, beginning with the type of license and the server name (if
a server license) or the path to the license file.
4. Write down the contents of the line that starts with Active license file(s), and the value that appears
in the line following it (for example, 27500@rainier).
5. Perform one of the following:
• If the line is Active license file(s) [Easy5_LMD_LICENSE_FILE], set the environment variable
Easy5_LMD_LICENSE_FILE to the output value displayed in Step 4 above (for example,
27500@rainier).
• If the line is Active license file(s) [MSC_LICENSE_FILE], find the value of the environment
variable MSC_LICENSE_FILE to see what license file Adams is using.
• If Easy5 and Adams are using different licenses (or license servers), set LM_LICENSE_FILE to
the value for the Easy5 license (for example 2500@bosco).
• If Easy5 and Adams are using the same license, your computer is configured properly.
6. For Windows platforms and when using Easy5 2013 or older, modify the Path environment variable
to include the path to the lib_em64t_IF91 subdirectory (64 bit Easy5) or lib_nt_IF91 subdirectory
(32 bit Easy5) of your Easy5 installation tree.
• If your Easy5 (2013 or older) model contains components from a licensed library (for example,
the Thermal-Hydraulic or Gas Dynamics libraries), you will need to make sure Adams finds your
Easy5 license. Failure to perform this step will result in the Easy5 license library not being found.
• The Easy5 model import feature in Adams (Adams importing an Easy5 library) is not supported
with the GNU compiler. If GNU compiler is required, an FMI based interface is recommended
(Adams importing an Easy5 FMU).
To find the appropriate value for the variable:
a. Start Easy5.
b. Open an Easy5 command shell: from the Easy5 File menu, select Open Command Shell.
c. At the command shell prompt, enter: echo %EZHOME%.
The output is the directory in which Easy5 is installed. You will use the directory information in
Step 5 below. The usual value of EZHOME is:
62 Adams 2023.1 Installation and Operations Guide
Installing the Adams Extension for Easy5
C:\Program Files\MSC.Software\Easy5\<version>\
Note: Check https://help.hexagonmi.com/ to find the versions of Easy5 that are compatible
with Adams. Select the current version, for example Adams 2023.1 - Online Help
(HTML) and go to Release Guide -> Supported Versions of Integration Products.
where:
• C: is the location of your adams_2023_1_windows64.exe file
• f1 is a lower-case f and the number 1
• c:\temp\mysetup.iss is the location and name of the batch setup file
3. Select OK.
4. Follow the installation instructions in the section, Installing Adams, 48.
The batch installation file (.iss) is created.
where:
• C: is the location of your adams_2023_1_windows64.exe file
• f1 is a lower-case f and the number 1
• c:\temp\mysetup.iss is the location and name of the batch setup file.
64 Adams 2023.1 Installation and Operations Guide
Installing Adams in Silent Mode (Batch)
[InstallShield Silent]
Version=v7.00
File=Response File
[File Transfer]
OverwrittenReadOnly=NoToAll
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-DlgOrder]
Dlg0={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdWelcome-0
Count=10
Dlg1={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdCustomerInfo-0
Dlg2={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-MSC_SetupType3-0
Dlg3={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdStartCopy-0
Dlg4={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-MSC_License-0
Dlg5={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-0
Dlg6={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-1
Dlg7={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-2
Dlg8={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-3
Dlg9={D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdFinish-0
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdWelcome-0]
Result=1
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdCustomerInfo-0]
szName=buildadm
szCompany=MSC Software Corporation
nvUser=1
Result=1
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-MSC_SetupType3-0]
szDir=C:\Program Files\MSC.Software\Adams\2023_1
Result=301 Installation Directory
SetupType=501
SetupName=Full
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-SdStartCopy-0]
Result=1
[Application]
Name=Adams
Version=18.1.0
Company=MSC Software Corporation
Lang=0009
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-MSC_License-0]
szEdit1=27500@yoda License server
Result=1
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-0]
Result=1
Sel-0=1
Sel-1=0
[{D6D7D44A-7056-4EAF-9B63-2691B41583DA}-AskOptions-1]
Result=1
Sel-0=1
Sel-1=1
Sel-2=1
6 Licensing on Windows
Overview
Licensing Basics
Specifying your License
Replacing Codes (Licenses) on an Existing Windows Server
Customizing End-User License Administration
66 Adams 2023.1 Installation and Operations Guide
Overview
Overview
Adams products use a license server to manage the access to its products. Therefore, before you can run the
products you just installed, you must license them. The next sections explain more about Adams licensing,
the initial licensing options, and how you can manage the licensing after you’ve initially licensed the products.
Licensing Basics, 67
Specifying your License, 68
Replacing Codes (Licenses) on an Existing Windows Server, 69
Customizing End-User License Administration, 70
CHAPTER 6 67
Licensing on Windows
Licensing Basics
You can license Adams products in the following ways:
Set up a license server that is available to your users through the network, and set up the number of
users who can use Adams. The number of users who can run Adams concurrently depends on the
number of licenses you purchased. Refer to your password certificate for information on the number
of users who can run Adams.
You can run the license server on one machine or on three. We strongly recommend that you use a
one-server configuration, however. If you select a three-server configuration, the machines act as
backups to the other machines. You must install passwords on all of the server machines to set up a
three-server configuration.
You can select to load only the licensing tools on the license server and install the Adams products
only on the clients.
You also can set up the licensing so that it is locked to a particular machine or node. If your Adams
licensing is node-locked, then users can only run Adams products on that machine. To see if you
have purchased node-locked licensing, refer to your password certificate.
Set up a client using an existing license server.
In both cases, the procedure for licensing Adams is the same.
68 Adams 2023.1 Installation and Operations Guide
Specifying your License
27500@hostname
If you do not know the name of the host, enter the command hostname at a command prompt. Or, you can
refer to the SERVER line of your password certificate/license file.
Starting Adams Products
Setting Preferences
Setting Your Working Directory
Using Distributed Computing for Nonlinear Adams Flex Bodies
High Performance Computing Considerations
72 Adams 2023.1 Installation and Operations Guide
Starting Adams Products
Note: We recommend that you use the Adams Toolbar to start your Adams products, but
if you want to automate certain operations, use the text-based Program Menu. For
more information, see the Running and Configuring online help.
Tip: Select the corresponding desktop icon for the product, if you installed it on your
desktop.
An alternative is to add the /bin directory under the Adams installation directory to your user
PATH environment variable. You can do this via the Control Panel:
74 Adams 2023.1 Installation and Operations Guide
Starting Adams Products
Check to see if you already have a PATH variable defined under “User variables”. If it exists then
edit it, add a semicolon “;” to the end of the existing value, and then add the “bin” directory under
the Adams installation directory. Otherwise select New..., use PATH for the variable name and add
the “bin” directory under the Adams installation directory as the value. The default location of this
directory is:
C:\Program Files\MSC.Software\Adams\2023_1_XXXXXX\bin
(where XXXXXX denotes the build number)
Once you are done click OK.
Note: Windows appends your User PATH to the System PATH environment variable, so there is
no need to copy the existing System PATH variable to your user PATH variable. This
behavior is unique to the User PATH variable. For all other environment variables, a User
variables definition overrides a System Variables definition.
CHAPTER 7 75
Running Adams Products
Setting Preferences
This section describes how you can set preferences, such as your working directory, graphics setting, and
memory model size.
Overview
When constructing a model containing nonlinear flexible bodies using Adams MaxFlex the model can be
configure to distribute the computing effort across multiple hosts by specifying Compute Resource
hostnames for the nonlinear flex bodies. A prerequisite for a simulation utilizing Compute Resource hosts is
that those hosts have been properly configured.
Before an Adams simulation is able to utilize distributed computing some network daemons must be started.
On a host on the local network a process called a Directory Service Server needs to be running. In addition,
a process called a Starter Daemon needs to be running on each compute host. When needed the Starter
Daemon process on a compute host will start one or more NLFE services. The figure below shows a diagram
of the relationship between Adams Solver, the network daemons, and the NLFE service.
Figure 7-4 Adams Solver, Network Deamons and NLFE service links
The Directory Service runs in a thread inside client kernel and is listening. This functions as a broker between
the Adams Solver process and the Starter Daemon on an external host. The Starter Daemon registers itself
with the Directory Service when it starts. The Directory Service keeps a list of registered hosts along with
their credentials. Later when Solver is connecting to an external host it starts by contacting the Directory
Service to obtain the host's credentials. The Directory Service runs automatically when required.
The Starter Daemon is a process that, when requested, starts up instances of services installed on a remote
host. Adams utilizes the Starter Daemon to start the NLFE service when required. A running Starter Daemon
is needed on each host that an Adams model utilizes. Only one Starter Daemon should be run on any given
host.
CHAPTER 7 79
Running Adams Products
%: adams<version> -clientmanager
Where, <version> is replaced with the actual string of the version of Adams installation, that is, 2023_1.
CHAPTER 7 81
Running Adams Products
Figure 7-7 NLFE Client Manager: Start and Stop Starter Daemon
82 Adams 2023.1 Installation and Operations Guide
Using Distributed Computing for Nonlinear Adams Flex Bodies
Add a colon (":") between the machine name and the Port Number as shown above.
CHAPTER 7 83
Running Adams Products
Overview
Setting Up the Client Machine
Updating Passwords
86 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter describes some basic administration and configuration operations you might want to perform
after you install the Adams products, and others that you might need to perform periodically as you obtain
new passwords. These operations include the following:
Setting Up the Client Machine, 87
Updating Passwords, 88
CHAPTER 8 87
Linux Administration and Configuration
Updating Passwords
If you receive new passwords from Hexagon, follow the instructions below to update your passwords. If you
receive new software along with the passwords, you should follow the complete installation instructions in
Installing Adams on Linux, 19
Note: If the license server started with root, you must be root to stop and start it.
Note: If you do not have an lmreread executable, copy lmdown and name it lmreread
You should now be able to run Adams products using the new licenses. If this fails, kill and restart the
daemons as follows:
# flexlm_install_dir/lmdown -c <path>/license.dat
# flexlm_install_dir/lmgrd -c <path>/license.dat
MSC Nastran Implicit Nonlinear (SOL 600) User’s GuideAdams 2020 FP1 Installation and
Operations Guide
Chapter 9: Troubleshooting
9 Troubleshooting
Overview
Troubleshooting on Windows
Troubleshooting on Linux
92 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This chapter describes how to generate problem reports to send to Adams Technical Support. It also lists some
common problems that can occur when installing, updating, and running Adams software, and recommends
solutions to those problems.
Troubleshooting on Windows, 93
Troubleshooting on Linux, 96
If you do not find your problem in this chapter or if the recommended solution does not solve your problem,
then:
Refer to the Adams Technical Articles at http://simcompanion.hexagon.com
Contact Adams Technical Support as explained in Getting Help, 7.
CHAPTER 9 93
Troubleshooting
Troubleshooting on Windows
Note: For correct results, you must run the problem report from the license server, not the client
machine.
The actions, when run for the first time in a given installation of Adams, known to MSC to trigger this alert
are:
Launch of Adams View or Adams View based products like Adams Car and Adams Driveline;
Windows security alert will reference "aview"
Creation of linear (modal) flexible body via Adams ViewFlex; Windows security alert will reference
"remotebootstrap.exe"
Creation of a nonlinear flexible body via import of a BDF; Windows security alert will reference
"remotebootstrap.exe"
Execution of a co-simulation via the Adams Co-simulation Interface (ACSI); Windows security alert
will reference "ACSI_Gui.exe"
To fix this permanently, click Allow access. This will add the particular Adams component (for example,
"aview" or "remotebootstrap.exe") to the Windows Firewall Allowed Program list and this dialog will no
longer display for the given version of Adams installed on the machine. Note that you need an Administrator
access to make this change.
To manage the Windows Firewall on your machine go to Control Panel Windows Firewall.
CHAPTER 9 95
Troubleshooting
Troubleshooting on Linux
Note: For accurate results, you must run the problem report from the license server, not the
client machine.
Check hostid on the system - Returns the hardware identification number from the system that is
used for Adams licensing. This identification number is also included in the problem report.
that the number of sockets and process file descriptors limitations for your system is adequate to handle all
of the licenses. See your operating system’s documentation for the maximum number of file descriptors
available on the system designated as your Adams license server.
The license server writes a debug log file as it runs. It writes an entry for each license request and return. If
the file becomes too large, you can edit the log file periodically.
The Adams license daemons send small amounts of data across the network. Each license transaction requires
approximately 1 KB of data. If there are a lot of transactions (in the hundreds), the network bandwidth use
can become significant. If this happens, you should consider keeping the license server on the same local area
network as the one being used for the Adams products.
10 Linux Installation
Roadmaps
Overview
File Server, License Server, and Client - Same Machine
File Server and License Server - Same Machine, Client - Different Machine
File Server and Client - Same Machine, License Server - Different Machine
File Server, License Server, and Client - Different Machines
File Server - Different Machine, License Server and Client - Same Machine
Different Linux Platforms - Heterogeneous Network
100 Adams 2023.1 Installation and Operations Guide
Overview
Overview
This appendix describes the overall steps or roadmaps that you perform to install Adams products depending
on your network configuration. Use these roadmaps to guide your installation. For complete installation and
licensing instructions, see Installing Adams on Linux for more information. The roadmaps are:
File Server, License Server, and Client - Same Machine, 101
File Server and License Server - Same Machine, Client - Different Machine, 102
File Server and Client - Same Machine, License Server - Different Machine, 103
File Server, License Server, and Client - Different Machines, 104
File Server - Different Machine, License Server and Client - Same Machine, 105
Different Linux Platforms - Heterogeneous Network, 106
For assistance in determining which roadmap to follow, see Table 10-1. It lists the seven types of configurations
and the page that contains the roadmap for performing installation and licensing for that type of
configuration. If your configuration is not in the table, review the options in each chapter and choose the
ones that best fit your needs.
Table 10-6 Roadmap When License Server and Client are the Same Machine
Do the following: For more information, see the section:
1. Log on to the central NFS server. --
2. Create an installation directory. Creating the Installation Directory, 22
3. Install Adams. Installing Adams, 23
4. Exit from the installation program. --
5. Log on to license server and client. --
6. Mount Adams installation directory from --
file server on license server system
through NFS.
7. Create a directory for Adams on this Creating the Installation Directory, 22
machine.
8. Install Adams Installing Adams, 23
9. Install network passwords. Licensing Adams When File and License Server Are Different
Systems, 41
10. Start the license server. Starting the Adams License Server, 42
11. Modify system startup procedures so they Restarting the Adams License Daemons, 43
include the restarting of the Adams
license manager.
12. Generate a troubleshooting report to Verifying a Successful License, 45
verify that all products and files were
properly installed.
106 Adams 2023.1 Installation and Operations Guide
Different Linux Platforms - Heterogeneous Network
In order to run Adams FMU on dSPACE, you will need to update the SCALEXIO firmware to 2021-A,
install dSPACE Hypervisor extension, and configure a Linux based virtual machine for running inside the
dSPACE Hypervisor extension. The following steps will guide you through this process.
1. Acquire new flashcard from dSPACE to configure SCALEXIO for 2021-A and update firmware.
Contact dSPACE Support for more information.
2. Installation of Hypervisor and Ubuntu 18.04 OS
https://www.dspace.com/en/pub/home/support/documentation.cfm?helpsetid=SCALEXIOHypervisorExtensionGuide
&externalid=Topic_97d999d8-e66f-4bda-be85-b6939d7c9ffe_--_&Language=en-us&Release=RLS2021-A
Contact dSPACE support for assistance with Installation of Hypervisor and the Ubuntu Operating
System
3. Setting up network and DNS on Ubuntu 18.04
DNS Servers - (Ask your IT for latest information on this if not known)
DNS suffix - (Ask your IT for latest information on this if not known)
Gateway - (Ask IT for latest information on this if not known)
122 Adams 2023.1 Installation and Operations Guide
4. Ubuntu VM configuration
Refer to the following link in the dSPACE 2021-A User Manual for configuration of Ubuntu VM.
It is highly recommended to use Ubuntu 18.04 to run Adams.
https://www.dspace.com/en/pub/home/support/documentation.cfm?helpsetid=SCALEXIOHypervisorExtensionGuide
&externalid=Topic_0b5482a1-82f0-4aa8-b7c8-4bd067a981c8_--_&Language=en-us&Release=RLS2021-A
Note that at a minimum, the RTOS (linux32) needs 2 CPUs to run. Adams requires at least 2 CPUs
to run on Ubuntu OS. However, Adams will run faster if more cores are assigned to Ubuntu OS.
5. Setup a shared filesystem between Ubuntu and 32-Bit Linux OS
Refer to the following link in the dSPACE 2021-A User Manual.
https://www.dspace.com/en/pub/home/support/documentation.cfm?helpsetid=SCALEXIOHypervisorExtensionGuide
&externalid=Topic_1eab0357-12cb-4dac-b817-243222eb2dfa_--_&Language=en-us&Release=RLS2021-A
{
"id" : 2,
"size" : 16384,
}
],
8. Settings on Ubuntu to Improve Real Time Performance
• Enable RT_PREMEMPT in the KERNEL (Requires building the kernel from source code).
• Isolate specific CPUs for real-time (Do note that the last CPU in Ubuntu OS is used by the
Adams main thread)
• Isolate interrupts to a specific CPU
• Disable Ubuntu Desktop UI
• Disable automatic updates for Ubuntu
• Additional Hypervisor configuration ( "allowIOonServiceCore" )
To accomplish the above steps please refer to the document “Configuration of Virtual Machines for
usage with the dSPACE Hypervisor Extension” which can be obtained from dSPACE support.
9. Run a simple example application to check the settings for Realtime performance. Please contact
dSPACE support for an example application.
"Start the application inside the VM first (sh start_shm_server.sh). It also contains a simple script to
route the corresponding shared memory irq or ethernet irq to the correct core.
The test application will print information on the round trip time for the interrupt from the
SCALEXIO to the VM and back."
The output looks something like this:
Info2021-08-23 16:52:02VM Call: min: 5.8145 us, avg: 6.3570 us,
max: 8.1595 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:52:01VM Call: min: 5.8312 us, avg: 6.3682 us,
max: 8.2464 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:52:00VM Call: min: 5.8248 us, avg: 6.3919 us,
max: 8.2155 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:59VM Call: min: 5.8362 us, avg: 6.3906 us,
max: 8.2753 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:58VM Call: min: 5.8405 us, avg: 6.3555 us,
max: 8.3262 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:57VM Call: min: 5.8348 us, avg: 6.4207 us,
max: 8.2561 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:56VM Call: min: 5.7578 us, avg: 6.4093 us,
max: 8.4046 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:55VM Call: min: 5.7952 us, avg: 6.4470 us,
max: 26.2536 us (total max: 9.6531 us) (0/0)
Info2021-08-23 16:51:54Application started.
Info2021-08-23 16:51:54VM Shared Memory with ID 0 communication
initialized (0/0)
Info2021-08-23 16:51:54VM Shared Memory with ID 0 opened. (0/0)
Info2021-08-23 16:51:54RTH Test Application (0/0)
Info2021-08-23 16:51:54Application loaded.
124 Adams 2023.1 Installation and Operations Guide
If the virtual machine is setup correctly, this will run forever without task overruns and jitter > 30 us.
10. Install pre-requisites for installing and running Adams on Ubuntu 18
To install all the prerequisites to run Adams, execute the following command in a terminal:
sudo apt install gcc g++ libsm6 libxrender1 libfontconfig1 tcsh libnss3 libnspr4 libxau6 gfortran p7zip
libpng-dev
11. Install Adams on Ubuntu 18
Use the REDHAT 7.9 installer to install Adams on Ubuntu 18.04 OS. To install Adams from
Ubuntu Terminal, type the following command from the location containing the Adams installer file:
./adams_2023.1_linux64_rh7.9_a.bin --mode console
12. Install Adams License
The license servers will work only if the DNS suffix is set correctly. Contact Adams Support for
setting up the Adams License.
Follow the steps in “Configuration of Virtual Machines for usage with the DSPACE Hypervisor Extension”
to move an interrupt to a specific core. The “Script 1 - startup_interrupt_aff_setting.sh” moves most of the
interrupts away from real-time cores (1-5 in this case) to the core 0.
Note: There are some interrupts that cannot be moved. This calls another script to move the
ethernet device to a real-time core, in this case it is core 5 where an adams process runs that
uses this device. Adams uses this ethernet device during simulation for TCP/IP connection
with the real-time application.
After moving the interrupts as necessary, execute the following command to list all the interrupts and make
sure there are no unwanted interrupts on the real-time cores
cat/proc/interrupts
The output received can be compared with the previous output using a difftool, to verify that the activity of
interrupts is isolated as required.
CPU0 CPU1 CPU2 CPU3 CPU4 CPU5
0: 0 0 0 0 0 0 IO-APIC 2-edge timer
1: 68 139 0 0 0 0 IO-APIC 1-edge i8042
6: 0 3 0 0 0 0 IO-APIC 6-edge floppy
8: 1 0 0 0 0 0 IO-APIC 8-edge rtc0
9: 0 0 0 0 0 0 IO-APIC 9-fasteo acpi
12: 2319 0 0 0 0 0 IO-APIC 12-edge i8042
14: 0 0 0 0 0 0 IO-APIC 14-edge ata_piix
15: 0 0 0 0 0 0 O-APIC 15-edge ata_piix
24: 0 0 0 0 0 0 PCI-MSI 2113536-edge virtio2-config
126 Adams 2023.1 Installation and Operations Guide
Note: It is important to execute this script when the VM starts or before starting the real-time
simulation as the settings would reset with every restart. This could also be setup to be
executed automatically when Ubuntu starts. Please refer to Ubuntu documentation for
more information running a script at boot time
Scripts
The scripts provided in this document can be used directly by copying them to blank file with an extension
of “sh” and enabling execute permissions.
Script 1 - startup_interrupt_aff_setting.sh
Script 2 - route_veth_irq.sh
Script 3 - route_shm_irq.sh
CHAPTER 12 127
dSPACE SCALEXIO® Configuration guide for Adams Real Time
Script 1 - startup_interrupt_aff_setting.sh
#!/bin/sh
Script 2 - route_veth_irq.sh
The script below is the content of “route_veth_irq.sh” used in the above script to move the interrupts for the
ethernet device to a real-time core. This needs 3 inputs the name of the device, core ID and softirq priority.
#!/bin/sh
VIRTIO_DEV=$(basename $(readlink
/sys/class/net/${ETH_DEVICE}/device))
echo Routing RX IRQs of device ${VIRTIO_DEV} to core ${CORE_ID}
IRQ_NUM=$(cat /proc/interrupts | grep ${VIRTIO_DEV}-input | cut
-d: -f 1 | tr -d '[:space:]')
128 Adams 2023.1 Installation and Operations Guide
SOFTIRQD_PID=$(pgrep ksoftirqd/${CORE_ID})
echo "Raising SOFTIRQ kernel thread [PID ${SOFTIRQD_PID}] to
SCHED_FIFO with priority ${SOFTIRQ_PRIORITY}"
chrt -f -p ${SOFTIRQ_PRIORITY} ${SOFTIRQD_PID}
VIRTIOIRQ_PID=$(pgrep irq/${IRQ_NUM}-)
echo "Raising IRQ kernel thread [PID ${VIRTIOIRQ_PID}] to
SCHED_FIFO with priority ${SOFTIRQ_PRIORITY}"
chrt -f -p ${SOFTIRQ_PRIORITY} ${VIRTIOIRQ_PID}
Script 3 - route_shm_irq.sh
The script below moves the shared memory interrupts to a specific core. This needs to be moved to a real-
time core since adams uses shared memory in the hypervisor during simulation.
#!/bin/sh
# This shell script moves the virtio shm interrupt to a specific
core
# shared memory id to route IRQ for
SHM_ID=$1
SHM_ID=$((SHM_ID+1))
SHM_PCI_PATH=/sys/bus/pci/devices/0000:02:0${SHM_ID}.0/msi_irqs
IRQ_NUM=$(ls /sys/bus/pci/devices/0000:02:0${SHM_ID}.0/msi_irqs)
echo "Shared Memory $1 uses IRQ ${IRQ_NUM}"
echo ${CORE_ID} > /proc/irq/${IRQ_NUM}/smp_affinity_list
// {
// "type" : "PCI Device",
// "name" : "My Custom PCI Device",
// "addr" : "02:00.0"
// },
{
// We may pass through Ethernet Channels by name
"type" : "Ethernet Channel",
"name" : "Eth0_1"
},
]
As can be seen above, the devices "Integrated Graphics Device", "USB Host Controller", "USB Host
Controller #2" and "My Custom PCI Device" are commented out and hence will not start with the VM.
CPU shielding
CPU shielding should be performed before starting the application. It may or may not have an impact if the
cores are already isolated. It is best to try this and verify the improvement in performance. It does not hurt
to have this on top of isolating cores as mentioned in “Configuration of Virtual Machines for usage with the
DSPACE Hypervisor Extension”.
The steps are as follows:
1. To add the real-time cores to the shield, execute the following command in the terminal to shield
cores 1-5.
cset shield --cpu 1-5
2. Launch the adams process using the shield as below.
cset shield --exec /home/mscsoftware/run_adams.sh
For example, run_adams.sh would look something like this.
#!/bin/sh
/home/mscsoftware/adams/adams2023.1/mdi -c python
/home/mscsoftware/adams/adams2023.1/controls/utils/adams_daemon.
py -I 192.168.2.15&