Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.07 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.07 KB
Raw

About NIX-MX

The NIX-MX project is an extension to NIX and provides Matlab bindings for NIX.

Development Status

The NIX-MX project has been developed and tested under Windows 32 and Windows 64 and can easily be built under MacOS. Specifically all of the features of NIX v1.4.1 have been implemented and tests for all of the methods exist and pass.

Getting Started (Windows 32/64)

Quick start packages, Release 1.4.1

The quick start packages are compiled under Windows 32/64 and contain all binary and Matlab files required to use NIX-MX with the respective Windows OS. The included NIX library is a stable release 1.4.1 build. To use the packages, unzip them into a folder of your choice and run the startup.m script from the root folder. Do not change the file/folder structure.

The Windows 64 package contains:

  • NIX library (stable release 1.4.1 build, compiled using BOOST 1.57.0, CPPUNIT 1.13.2 and HDF 1.10.1)
  • NIX-MX (Release 1.4.1)

The Windows 32 package contains:

  • NIX library (stable release 1.4.1 build, compiled using BOOST 1.57.0, CPPUNIT 1.13.2 and HDF 1.10.1)
  • NIX-MX (Release 1.4.1)

Build NIX-MX under Windows

To build NIX-MX under Windows please follow the guide provided at WinBuild.md. For an automated build, you can also use the win_build.bat script after you have read the build guide and set up all required paths and repositories accordingly.

Getting Started (macOS)

Quick start packages, Release 1.4.1

The quick start packages (https://github.com/G-Node/nix-mx/releases) are compiled under macOS Catalina using Matlab 2020a and contain a statically built mex file, nix m-files, tests, and a startup.m script. To use nix-mx unzip the file and run the startup.m script in MATLAB. This simply adds the current folder containing the mex files to the MATLAB path. Do not change the file/folder structure.

Once this is done, you may want to test it. Go to the MATLAB command line, change into the nix-mx folder and execute:

>>RunTests

This will execute a bunch of tests, there may be warnings but no test should fail.

Note: Apple might block the execution because they cannot verify the app. You can allow the execution in your SystemPreferences -> Security -> General

Build NIX-MX under macOS

To build NIX-MX under macOS please follow the guide provided at MacOSBuild.md

Note: Build issues with new MATLAB releases

Mathworks release a new edition twice a year. We may not be able to keep up with this pace for lack of time or because we do not have access to the current release.

Often it is only the build configuration that fails. In such cases please check out this issue. In case you successsfully built and tested with a newer MATLAB version than was supported please consider submitting the changes via pull-request. Thank you!