Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 4.15 KB

README.md

File metadata and controls

93 lines (68 loc) · 4.15 KB
Raw

setup_mex

license Test MEX View setup_mex on File Exchange

What

This package provides scripts that attempt to facilitate setting up the MATLAB MEX, focusing on macOS and Windows.

Note that MATLAB requires you to install a supported (C or Fortran) compiler along with Xcode (on macOS with Intel chips) or Microsoft Visual Studio (on Windows). This package is not a hacking tool to circumvent these requirements, but a tool to help MATLAB recognize your compiler after these requirements are satisfied.

As of April 2024, we do not support Fortran setup on macOS with silicon chips, because MathWorks requires the NAG Fortran compiler for such a setup, which is not available for free.

For Fortran, this package provides scripts (install_oneapi_macos.sh for macOS with Intel chips and install_oneapi_windows.bat for Windows) to help you install the Fortran compiler from Intel oneAPI, available free of charge. This is the compiler officially supported by MATLAB.

This package has been successfully tested on all recent releases of MATLAB under recent versions of Windows and macOS via GitHub Actions. Nevertheless, I will not be surprised if it does not work on your machine. In that case, you need to consult a local MATLAB expert or the technical support of MathWorks about "how to set up MEX".

How

Before starting, clone this repository. Then do the following according to your system (macOS or Windows) and your need (C or Fortran).

macOS with Intel chips

  • C

    • Install Xcode with Clang
    • In MATLAB, change the directory to the folder of the repository, run 
      try_mex_setup('c')

  • Fortran

    • Install Xcode with Clang
    • In terminal, change the directory to the folder of the repository, run 
      sudo bash install_oneapi_macos.sh
    • In MATLAB, change the directory to the folder of the repository, run 
      try_mex_setup('fortran')

Windows

  • C

    • Install Microsoft Visual Studio with the "Desktop development with C++" workload
    • In MATLAB, change the directory to the folder of the repository, run 
      try_mex_setup('c')

  • Fortran

    • Install Microsoft Visual Studio with the "Desktop development with C++" workload

    • In cmd (not PowerShell), change the directory to the folder of the repository.

      -- If your MATLAB version is R2023b or below, then run

      install_oneapi_windows.bat 2023

      -- If your MATLAB version is R2024a or above, then run

      install_oneapi_windows.bat

    • In MATLAB, change the directory to the folder of the repository, run

      try_mex_setup('fortran')

Remarks

  1. Always adopt the default options (e.g., installation directory) when installing Xcode (on macOS) or Microsoft Visual Studio (on Windows). Otherwise, MATLAB may not be able to locate them.

  2. Choose the version of Xcode or Microsoft Visual Studio according to that of your MATLAB, following the official documentation of MathWorks. The latest version does not necessarily work.