Copyright © 2024 Maplesoft, a division of Waterloo Maple Inc.
Copyright © 2024 Maplesoft, a division of Waterloo Maple Inc.
This installation guide contains information on how to install MapleSim™ and the MapleSim add-ons. Use it to install the products that you have purchased.
MapleSim 2024.1 requires that Maple 2024.1 be installed. If you have Maple 2024, installing MapleSim 2024.1 will automatically upgrade your Maple version to Maple 2024.1. If you do not have Maple 2024 and require Maple 2024 installation and activation instructions, you can view the Maple 2024 Installation and Licensing Guide from the Maplesoft Documentation Center.
On Windows platforms, MapleSim will use the clang compiler shipped with Maple for compilation. On Mac platforms, if you do not have Xcode installed, MapleSim will use the built-in in-memory LLVM compiler. On Linux platforms, if you do not have GCC installed, MapleSim will use the built-in in-memory LLVM compiler.
Note: On Mac and Linux, Xcode/GCC are required for FMU generation.
During the installation process, you will need the purchase code that was sent to you in an email.
MapleSim add-on products are installed in subdirectories within the Maple directory.
MapleSim and each Add-on product require license files to operate. License files for earlier versions will not work with MapleSim 2024.1 and Add-ons. You must activate the single user versions of MapleSim 2024.1 and Add-ons to obtain your license files. If you are running a single user installer, you can activate during the installation process. If you do not activate during the installation process, follow the steps below.
Note: Activation requires an Internet connection. If your computer does not have an Internet connection, please contact your distributor or Maplesoft customer service.
A license (.dat) file will be saved in the toolbox\<product name>\license folder of your Maple 2024 installation. If you experience difficulties with activation, check our FAQs page at https://faq.maplesoft.com.
A license (.dat) file will be saved in the toolbox/<product name>/license folder of your Maple 2024 installation. If you experience difficulties with activation, check our FAQs page at https://faq.maplesoft.com.
A license (.dat) file will be saved in the toolbox/<product name>/license folder of your Maple 2024 installation. If you experience difficulties with activation, check our FAQs page at https://faq.maplesoft.com.
Note: For network license installations, the system administrator must activate a network license and configure the license manager. For full instructions on how to configure the license manager, refer to the Install.html file in your Maple 2024 install directory.
MapleSim add-on products are installed in subdirectories within the Maple directory.
It is possible to install both single user and network versions of MapleSim and Add-ons using an unattended mode option. There are two ways to perform an unattended installation of MapleSim and Add-ons:
Note: While you can install the single user version of MapleSim and Add-ons using an unattended mode option, it is not possible to activate the product at this time. After the silent installation of the single user version of MapleSim 2024.1 and Add-ons is complete, follow the activation instructions in Activating Single User Versions.
You can run an unattended installation without an option file by specifying the installation options directly in the command line. To run the unattended installation this way, do the following:
MapleSim2024.1ProductWindowsX64Installer.exe --option optionvalue
For example, use the command
MapleSim2024.1ProductWindowsX64Installer.exe --mode unattended
to install MapleSim and Add-ons in unattended mode.
./MapleSim2024.1ProductLinuxX64Installer.run --option optionvalue
For example, use the command
./MapleSim2024.1ProductLinuxX64Installer.run --mode unattended
to install MapleSim and Add-ons in unattended mode.
MapleSim2024.1ProductMacInstaller.app/Contents/MacOS/installbuilder.sh --option optionvalue
For example, on Macintosh, use the command
MapleSim2024.1ProductMacInstaller.app/Contents/MacOS/installbuilder.sh --mode unattended
to install MapleSim and Add-ons in unattended mode.
You can create your own options.txt file using the following example as a template:
mode=unattended
defaultapp=1
desktopshortcut=1
maplepath= <Path to Maple 2024 installation>
licenseType=network
serverName=myServerName
portNumber=27000
Note: If you created your option file in a directory other than the directory in which the MapleSim2024.1ProductWindowsX64Installer.exe file is located, you must specify the path to the option file when you run this command.
You can create your own options.txt file using the following example as a template:
mode=unattended
desktopshortcut=1
maplepath=<Path to Maple 2024 installation>
licenseType=network
serverName=myServerName
portNumber=27000
Note: If you created your option file in a directory other than the directory in which the MapleSim2024.1ProductLinuxX64Installer.run file is located, you must specify the path to the option file when you run this command.
You can create your own options.txt file using the following example as a template:
mode=unattended
desktopshortcut=1
maplepath=<Path to Maple 2024 installation>
licenseType=network
serverName=myServerName
portNumber=27000
Note: If you created your option file in a directory other than the directory in which the MapleSim2024.1ProductMacInstaller.dmg file is located, you must specify the path to the option file when you run this command.
Option Name | Description | Allowed Values | Default Value | Platform Availability |
optionfile | Name of option file | string |
| Mac; Linux; Windows |
mode | Installation mode | win32; unattended | win32 | Windows |
installer-language |
| en | en | Mac; Linux; Windows |
upgradeOrReinstall | If an existing installation is found, specify whether to upgrade the current installation or uninstall the old installation before reinstalling. | upgrade; reinstall |
| Mac; Linux; Windows |
defaultapp | Make Maple 2024 the default application for Maple worksheet (.mw and .mws) files | 0 or 1 | 1 | Windows |
desktopshortcut | Install desktop shortcuts | 0 or 1 | 1 | Mac;Linux;Windows |
defaulttoolbox | Default toolbox is either Maple or MATLAB® (only valid if the MATLAB® installation contains the MATLAB® Symbolic Math Toolbox™) | Maple; MATLAB |
| Mac; Linux; Windows |
licenseType | Type of Licensing | single; network | single | Mac; Linux; Windows |
activate | Activate Maplesoft product license | now; later | now | Mac; Linux; Windows |
serverName | Name of license server | string |
| Mac; Linux; Windows |
portNumber | Port number on license server | numeric | 27000 | Mac; Linux; Windows |
maplepath | Path to Maple 2024 installation | string |
| Mac; Linux; Windows |
enable-components <enable-components> | Comma-separated list of components | maplesim ControlDesign CadToolbox MapleSimConnectors MapleSimConnector BRConnector FMIConnector JMAGRTConnector MapleSimComponents BatteryComponentLibrary DrivelineComponentLibrary HeatTransferLibrary RopesAndPulleysComponentLibrary TireComponentLibrary WebHandlingComponentLibrary | maplesim, ControlDesign, CadToolbox, MapleSimConnectors, MapleSimConnector, BRConnector, FMIConnector, JMAGRTConnector, MapleSimComponents, BatteryComponentLibrary, DrivelineComponentLibrary, HeatTransferLibrary, RopesAndPulleysComponentLibrary, TireComponentLibrary, WebHandlingComponentLibrary | Mac†; Linux‡; Windows |
disable-components <disable-components> | Comma-separated list of components | maplesim ControlDesign CadToolbox MapleSimConnectors MapleSimConnector BRConnector FMIConnector JMAGRTConnector MapleSimComponents BatteryComponentLibrary DrivelineComponentLibrary HeatTransferLibrary RopesAndPulleysComponentLibrary TireComponentLibrary WebHandlingComponentLibrary |
| Mac†; Linux; Windows |
†: The JMAGRTConnector and CadToolbox options are not available for Macintosh installers.
toolbox/<product name>/uninstall/uninstall --mode unattended
Before starting the Windows Network version of MapleSim 2024.1 and Add-ons, you must obtain your license file and start the license manager by completing the following tasks.
MapleSim 2024.1 and Add-ons requires a MapleSim 2024.1 and Add-ons license file to operate. License files for earlier versions of MapleSim and Add-ons do not work with MapleSim 2024.1 and Add-ons. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
Note: If you are using Windows 7, right-click Activate Maple and select Run as administrator.
To run Maple and associated products, you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store Maple and associated product license files there as well.
Complete the following tasks:
Using Windows Explorer, move all of the license files to a common directory, for example, C:\Program Files\Maple Network Tools\activate.
Service Name | Enter a name for the service (optional) |
Path to the lmgrd.exe file | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\lmgrd.exe |
Path to the license file Note: The path to the license file should not contain a terminating backslash | C:\Program Files\Maple Network Tools\activate |
Path to the debug log file Enter the path to the directory containing the debug log file. You must create this file manually (log.txt is the manually created file in the example below), as it is not automatically generated. | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\log.txt |
You can now use your network licensed Maplesoft products.
FlexNet Publisher does not run on Novell or IPX/SPX. Follow these instructions to install the license manager on any network that is exclusively a Novell environment.
Before starting the macOS® Network version of MapleSim 2024.1 and Add-ons, you must obtain your license file and start the license manager by completing the following tasks.
MapleSim 2024.1 and Add-ons requires a MapleSim 2024.1 and Add-ons license file to operate. License files for earlier versions of MapleSim and Add-ons do not work with MapleSim 2024.1 and Add-ons. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
To run Maple and associated products, you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store Maple and associated product license files there as well.
Complete the following tasks:
Go to the location of the FlexNet Publisher utilities that are currently being used. For MapleSim 2024.1 and Add-ons, the default location is /Users/<username>/Applications/Maple Network Tools/FLEXlm/11.13.1.2/. Enter the command:
./lmdown
Copy all the MapleSim and Add-ons network license files to /Users/<username>/Applications/Maple Network Tools/activate.
Note: Point to the directory only, not an actual license file.
./lmgrd -c license_file_path -l debug_log
where license_file_path is the full path to the directory containing the license files and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
You can now use your network licensed Maplesoft products.
Before starting the Linux Network version of MapleSim 2024.1 and Add-ons, you must obtain your license file and start the license manager by completing the following tasks.
MapleSim 2024.1 and Add-ons requires a MapleSim 2024.1 and Add-ons license file to operate. License files for earlier versions of MapleSim and Add-ons do not work with MapleSim 2024.1 and Add-ons. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
To run Maple and associated products, you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store Maple and associated product license files there as well.
Complete the following tasks:
Go to the location of the FlexNet Publisher utilities that are currently being used. For MapleSim 2024.1 and Add-ons, the default location is /usr/local/MapleNetworkTools/FLEXlm/11.13.1.2/. Enter the command:
./lmdown |
Copy all of the MapleSim and Add-ons network license files to one folder, for example, $HOME/MapleNetworkTools/activate.
Note: Point to the directory only, not an actual license file.
./lmgrd -c license_file_path -l debug_log
where license_file_path is the full path to the directory containing the license files and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
You can now use your network licensed Maplesoft products.
Named Network Users run MapleSim and Add-ons on their own client machines. These client machines are connected to the license server over the network. The Network Named User licensing option allows system administrators to strictly enforce which users, or client machines, may run MapleSim and Add-ons.
When you install Maple Network Tools, an options file (.opt) is automatically created in the $Maple Network Tools/activate directory.
Note: By default, the vendor daemon looks for the options file (maplelmg.opt) in the same directory that contains the license file used by the license server manager.
To set up Named Network User licensing, perform the following steps:
To manually edit the options file, perform the following steps:
INCLUDE Maple USER User1
INCLUDE Maple USER User2
INCLUDE Maple USER User3
INCLUDE Maple USER User4
INCLUDE MapleSim USER User3
INCLUDE MapleSim USER User4
INCLUDE <PRODUCTLICENSE>2024 USER User4
In the example above, <PRODUCTLICENSE> could be any of the following:
GROUP Maple_users User1 User2 User3 User4
GROUP MapleSim_users User3 User4
INCLUDE Maple GROUP Maple_users
INCLUDE MapleSim GROUP MapleSim_users
INCLUDE <PRODUCTLICENSE>2024 USER User4
In the example above, <PRODUCTLICENSE> could be any of the following:
When the installation and activation process is complete, start MapleSim. Examples are available for MapleSim and any activated Add-on product. To access the examples, from the Help menu, select Examples.
For more information, see the Getting Started Guide for your Add-on product, which can be found on your desktop.
To optimize the performance of graphics in MapleSim 2024.1 and Add-ons, it is strongly recommended that you install the latest driver software available for your video card. Before using MapleSim 2024.1 and Add-ons, follow the steps in this section to verify and, if necessary, upgrade your video card driver software.
Note: This step requires that you are logged into your computer as a root user or have sudo access. If you are using a network or shared computer, you may need to contact your system administrator.
01:00.0 VGA compatible controller: ATI Technologies Inc RV280 [Radeon 9200] (rev 01)
01:00.1 Display controller: ATI Technologies Inc RV280 [Radeon 9200] (rev 01)
If the wizard indicates that the latest driver software is installed, click Finish to close the wizard. Your computer is configured to display graphics in MapleSim 2024.1 and Add-ons.
If the wizard indicates that a more current version of the driver software is available, follow the on-screen instructions to install the update.
If the version number of the latest driver software available from the vendor matches the version number of the driver software installed on your computer, your computer is configured to display graphics in MapleSim 2024.1 and Add-ons. If a more current version is available, download the driver software from the website and install it on your computer.
Note: It is not recommended that you use driver software updates automatically detected by Linux software upgrade utilities.
If no driver software update is listed for your video card in the Software Update window, the latest version is installed on your computer. Your computer is configured to display graphics in MapleSim 2024.1 and Add-ons.
If a driver software update is listed, select the entry from the list and click Install. Follow the on-screen instructions to complete the installation.
If you are using a Linux operating system, or if you are using a Windows or macOS operating system and the driver software that was automatically detected does not function as expected, download and install the latest driver from the website of the video card vendor.
First, determine whether hardware accelerated graphics are turned on.
If hardware accelerated graphics are turned on, you will see a line that reads direct rendering: Yes. If this line reads direct rendering: No, hardware accelerated graphics are not turned on.
You can search the package management system of your Linux installation for drivers installed on your computer. Linux distributions use different package management systems; the instructions below are provided for the two most common Linux distributions.
dpkg-based Linux distributions such as Ubuntu
To query which packages are installed on your system, run the dpkg -l command. (Note that this is a lower-case letter L.) This command will display several lines of output, so it is useful to limit the output using the grep command. Continuing with the example above, enter the following command to search for NVIDIA® drivers.
dpkg -1 | grep -i nvidia
If you have a hardware accelerated driver installed, you will see an output line such as nvidia-glx-177. In this example, 177 is the major version number of the driver. The full driver version number is displayed in the second column. For example, it will look like 177.82-0ubuntu0.1 on a Ubuntu system.
Hardware accelerated AMD® and ATI™ drivers are named fglrx on Linux. For example, the package name could be fglrx-amdcccle and the version number may look like 2:8.543-0ubuntu4.1 on a Ubuntu system.
Intel® integrated accelerated graphics hardware may contain intel in the package name or just the chipset information, such as i810.
rpm-based Linux distributions such as SuSE and Red Hat Enterprise Linux
To query which packages are installed on an rpm-based Linux system, run the rpm -qa command. This command will list every package installed on your computer, so you can limit the search by using the grep command. For example,
rpm -qa | grep nvidia
To download the latest driver software for your video card, visit the website of your video card vendor.
Visit http://support.amd.com/us/gpudownload/Pages/index.aspx and search for the driver software for your operating system and video card type. Download and install the latest driver software available for your video card.
Note: If you are using an AMD Catalyst™ or ATI Catalyst video card, download the Catalyst Software Suite.
Visit http://www.intel.com/support/graphics/ and search for the driver software for your chipset type. Download and install the latest driver software available for your video card.
For more information about identifying your chipset type in Windows, visit http://www.intel.com/support/chipsets/sb/cs-009245.htm.
For more information on upgrading your driver software in Linux, visit http://www.intel.com/support/graphics/sb/cs-010512.htm.
Visit http://www.nvidia.com/Download/index.aspx and search for the driver software for your operating system and video card type. Download and install the latest driver software available for your video card.
To optimize the performance of graphics in MapleSim and Add-ons, it is strongly recommended that you use the latest driver software available for your video card. For more information on verifying your video card driver software, see Verifying Video Card Driver Requirements.
For optimal performance, you should install and run MapleSim 2024.1 and Add-ons on a physical computer. If you run MapleSim 2024.1 and Add-ons on a virtual machine, you may experience performance issues.
For information about supported platforms for MapleSim Add-ons please see, https://www.maplesoft.com/products/system_requirements.aspx#maplesimaddons
Version | CPU | Recommended RAM | Hard Disk |
Windows 10 | AMD X86_64 1 GHz Intel Xeon, Intel 64 | 4 GB | 10 GB |
Windows 11 | AMD X86_64 1 GHz Intel Xeon, Intel 64 | 4 GB | 10 GB |
Windows Server 2019 | AMD X86_64 1 GHz Intel Xeon, Intel 64 | 4 GB | 10 GB |
Windows Server 2022 | AMD X86_64 1 GHz Intel Xeon, Intel 64 | 4 GB | 10 GB |
Vendor | CPU | Operating System | Version | Recommended RAM | Hard Disk |
Apple | 64-bit Intel | macOS | 12, 13, 14 | 4 GB | 10 GB |
Apple | ARM64 | macOS | 12, 13, 14 | 4 GB | 10 GB |
Vendor | Operating System Version | CPU | Recommended RAM | Hard Disk | Additional required packages |
Red Hat Enterprise Linux | 8, 9 | Intel 64 or AMD X86_64 | 4 GB | 10 GB | redhat-lsb |
SUSE Linux Enterprise Desktop | 15 | Intel 64 or AMD X86_64 | 4 GB | 10 GB | lsb |
Ubuntu | 22.04 LTS, 23.10 | Intel 64 or AMD X86_64 | 4 GB | 10 GB | lsb-base, lsb-core |
The following is a list of supported C++ compilers. Note that some add-ons have specific compiler requirements (see https://www.maplesoft.com/products/system_requirements.aspx#maplesimaddons for details).
Platform | Supported Compilers |
Windows (64-bit) | Microsoft Visual Studio 2022 |
Linux (64-bit) | GCC |
Macintosh** | Xcode 5.1.1 (or greater) with the Command Line Tools |
**: For information on how to install and configure Xcode, check our FAQs page at https://faq.maplesoft.com.
Note: Maple uses the Flexera Software Corporation FlexNet Publisher as its license manager. This document contains all the information you require for a standard Maple installation. For more information, refer to the FlexNet Publisher documentation at http://www.flexerasoftware.com/.
Maple, MapleSim, Maplesoft, and Waterloo Maple are trademarks of Waterloo Maple Inc.
Intel is a registered trademark of Intel Corporation.
Linux is a registered trademark of Linus Torvalds.
Microsoft, Windows, Windows Server, Excel, Visual Studio, and Visual C++ are registered trademarks of Microsoft Corporation.
Macintosh and macOS are registered trademarks of Apple Computer, Inc.
Arm is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
NVIDIA is a registered trademark of NVIDIA Corporation.
AMD, ATI, AMD Catalyst, and Catalyst are either trademarks or registered trademarks of Advanced Micro Devices, Inc.
Java and JRE are registered trademarks of Oracle and/or its affiliates.
FLEXlm and FlexNet are registered trademarks of Flexera Software Corporation.
JMAG is a registered trademark of JSOL Corp. in the US and other countries.
MATLAB and Symbolic Math Toolbox are trademarks or registered trademarks of The MathWorks, Inc.
All other brand names or product names are trademarks or registered trademarks of their respective companies.