Skip to content

Latest commit

 

History

History
43 lines (39 loc) · 2.37 KB

readme.md

File metadata and controls

43 lines (39 loc) · 2.37 KB
Raw

Experimental MATLAB Toolbox for Cantera

This experimental Matlab Toolbox for Cantera changes the Matlab interface to the modern Matlab structure and syntaxes for OOP. It replaces the MEX interface with direct function calling from Cantera CLib.

Installation guide:

  1. Install Matlab (any release newer than R2008a).
  2. Compile Cantera from Source and install in your Conda environment, as directed in this link. https://cantera.org/install/compiling-install.html. The experimental Matlab Toolbox does not require a SCons option to install at this moment since it's stand-alone. It also does not require the current Matlab Toolbox to be installed.
  3. For first time users, launch Matlab, then navigate to /path/to/cantera/source/code (the folder containing interfaces and samples) using "Browse for Folder". Note for Ubuntu users: Matlab must be launched from the terminal using the following command: LD_PRELOAD='/usr/lib/x86_64-linux-gnu/libstdc++.so.6' matlab -softwareopengl. This is because Matlab does not load the correct GLIBC++ library on start-up and will return an error when loading the Cantera toolbox.
  4. In the Matlab command window, run addpath(genpath([pwd, '/interfaces/matlab_experimental'])) to add search path for the experimental toolbox.
  5. In the Matlab command window, run cd([pwd, '/interfaces/matlab_experimental/Utility']) to navigate to the Utility folder.
  6. Open the file named 'ctRoot.m', in the second line, edit output= to output='/path/to/conda/environment', then save the file. This sets the search path for the ctLoad command to find the shared library file for Cantera.
  7. Make sure the current (old) Matlab Toolbox for Cantera (if it's already installed) and samples files are removed from the Matlab search path. Having both the current and experimental version of the toolbox in the search path will lead to conflicts. The command to remove search path in Matlab is rmpath.
  8. In the Matlab command window, run savepath to save all search paths.
  9. To switch back to the current matlab toolbox, revert the search paths.

Usage guide:

  1. To start using the experimental toolbox, run ctLoad command.
  2. Refer to examples in /samples/matlab_experimental in your Cantera source code directory.
  3. To stop using the new Cantera interface, run the following commands: ctCleanUp ctUnload.