INSTALL.md

SimuliCore Installation Guide

Before proceeding with the installation, please review the Prerequisites section to ensure your system meets all necessary requirements.

Table of Contents

1. Linux Installation
2. Windows Installation
3. macOS Installation
4. Additional Configuration Arguments

Linux Installation

1. Open a terminal window.

2. Clone the repository:

   git clone git@github.com:simulisoft/simulicore.git
   cd simulicore

   Throughout this document, the top-level directory will be referred to as <simulicore_root>.

3. To configure Intel® MKL, open the following file:

   <simulicore_root>/cmake/3rd/mkl.lin.cmake

   Configure the paths INTEL_MKL_ROOT and INTEL_ICC_ROOT to reference your installed copies of Intel® MKL and Intel® Compiler, respectively.

   For additional information, please consult the Intel® MKL Linking Guide.

4. To configure NVIDIA® CUDA, open the following file:

   <simulicore_root>/cmake/3rd/cuda.lin.cmake

   Configure the paths NVIDIA_CUDA_ROOT and NVIDIA_CUDSS_ROOT to reference your installed copies of NVIDIA® CUDA Toolkit and NVIDIA® cuDSS, respectively.

   For additional information, please consult the CUDA & cuDSS Linking Guide.

5. Select a build directory build_dir and execute the CMake command to configure the project:

   cmake -S <simulicore_root> -B <build_dir>

   For additional configuration options, please refer to the Additional Configuration Arguments section below.

6. Compile and install the project:

   cmake --build <build_dir>
   cmake --install <build_dir>

Windows Installation

1. Clone the repository using your preferred cloning method:

   https: https://github.com/simulisoft/simulicore.git
   ssh: git@github.com:simulisoft/simulicore.git

   Throughout this document, the top-level directory will be referred to as <simulicore_root>.

2. To configure Intel® MKL, open the following file:

   <simulicore_root>/cmake/3rd/mkl.win.cmake

   Configure the paths INTEL_MKL_ROOT and INTEL_ICC_ROOT to reference your installed copies of Intel® MKL and Intel® Compiler, respectively.

   For additional information, please consult the Intel® MKL Linking Guide.

3. To configure NVIDIA® CUDA, open the following file:

   <simulicore_root>/cmake/3rd/cuda.win.cmake

   Configure the paths NVIDIA_CUDA_ROOT and NVIDIA_CUDSS_ROOT to reference your installed copies of NVIDIA® CUDA Toolkit and NVIDIA® cuDSS, respectively.

   For additional information, please consult the CUDA & cuDSS Linking Guide.

   Warning: Microsoft Visual Studio may fail to configure the project with CUDA 13. If you encounter configuration issues, please use the alternative BASH-based workflow below (Option B) instead of the Visual Studio approach.

4. Choose one of the following installation methods:

   Option A (Visual Studio):

   a. Launch Microsoft Visual Studio and open the simulicore_root directory.

   b. Configure CMake within Microsoft Visual Studio by navigating to Project > CMake Settings for SimuliCore.

   For additional configuration options, please refer to the Additional Configuration Arguments section below.

   c. Compile the project by selecting Build > Build All.

   d. Install the project by selecting Build > Install SimuliCore.

   Option B (Windows BASH - Alternative for CUDA 13 compatibility):

   a. Open a Windows BASH terminal (e.g., Git Bash).

   b. Select a build directory build_dir and execute the CMake command to configure the project:

   cmake -S <simulicore_root> -B <build_dir>

   For additional configuration options, please refer to the Additional Configuration Arguments section below.

   c. Compile and install the project:

   cmake --build <build_dir> --config Release
   cmake --install <build_dir> --config Release

macOS Installation

1. Open a terminal window.

2. Clone the repository:

   git clone git@github.com:simulisoft/simulicore.git
   cd simulicore

   Throughout this document, the top-level directory will be referred to as <simulicore_root>.

3. Open the following file:

   <simulicore_root>/cmake/3rd/armpl.mac.cmake

   Configure the path ARMPL_ROOT to reference your installed copy of Arm Performance Libraries.

   For additional information, please consult the Arm Performance Libraries Linking Guide.

4. Select a build directory build_dir and execute the CMake command to configure the project:

   cmake -S <simulicore_root> -B <build_dir>

   For additional configuration options, please refer to the Additional Configuration Arguments section below.

5. Compile and install the project:

   cmake --build <build_dir>
   cmake --install <build_dir>

Additional Configuration Arguments

The following list presents configuration arguments applicable to the entire project.

• Linux: Append the desired options to the CMake Configuration command.
• macOS: Append the desired options to the CMake Configuration command.
• Windows: Add the desired options in the "CMake command arguments" section within the CMake Settings.

Installation Directory

The default installation directories are as follows:

• Linux/macOS: <simulicore_root>/install
• Windows: <simulicore_root>/out/install/<build-type>

To specify a custom installation directory, use one of the following options:

--install-prefix=<your_install_path>

or

-DCMAKE_INSTALL_PREFIX=<your_install_path>