From ad3ac0a1add8f2f5dc02964c4d257712a5535689 Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Fri, 18 Jul 2014 14:37:47 +0000 Subject: [PATCH] [Matlab/Doc] Add automatically generated Contents.m to the toolbox. --- .gitignore | 7 ++--- interfaces/matlab/toolbox/Contents.m | 35 ------------------------- interfaces/matlab/toolbox/Contents.m.in | 9 +++++++ src/matlab/SConscript | 6 +++++ 4 files changed, 19 insertions(+), 38 deletions(-) delete mode 100755 interfaces/matlab/toolbox/Contents.m create mode 100644 interfaces/matlab/toolbox/Contents.m.in diff --git a/.gitignore b/.gitignore index 4788806e8..aa233f8ae 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ build/ test/work/ include/cantera/base/config.h interfaces/matlab/ctpath.m +interfaces/matlab/toolbox/Contents.m stage/ .sconsign.dblite .sconf_temp @@ -35,6 +36,6 @@ config.log coverage/ coverage.info doc/sphinx/cython/examples -doc/sphinx/matlab/examples/*.rst -doc/sphinx/matlab/tutorials/*.rst -doc/sphinx/matlab/code-docs/*.rst +doc/sphinx/matlab/examples/ +doc/sphinx/matlab/tutorials/ +doc/sphinx/matlab/code-docs/ diff --git a/interfaces/matlab/toolbox/Contents.m b/interfaces/matlab/toolbox/Contents.m deleted file mode 100755 index 65a2ae851..000000000 --- a/interfaces/matlab/toolbox/Contents.m +++ /dev/null @@ -1,35 +0,0 @@ -% Cantera Toolbox. -% Version 1.0 17-April-2002 -% -% Cantera is an open-source, object-oriented software package to aid -% the analysis and simulation of chemically-reacting flows. It -% consists of a computational kernel written largely in C++, along -% with interface libraries for several programming languages, -% including Fortran 90, Python, and MATLAB. More information about -% Cantera is available at http://www.cantera.org. -% -% This toolbox is the Cantera MATLAB interface. -% -% Cantera object construction. -% Solution - construct a Solution object. -% -% Constants. -% oneatm - One atmosphere. -% gasconstant - Universal gas constant. -% -% Gas mixture models. -% IdealGasMix - Ideal gas mixtures. -% GRI30 - GRI-Mech 3.0. -% air - air. -% -% Zero-dimensional reactor models. -% reactor - A general, customizable reactor. -% conhp - An adiabatic, constant pressure reactor. -% conuv - An adiabatic, constant volume reactor. -% -% Utilities. -% geterr - Get Cantera error message. -% adddir - Add a directory to Cantera's search path -% ctclear - Clear all objects from memory. -% -% Copyright 2002 California Institute of Technology diff --git a/interfaces/matlab/toolbox/Contents.m.in b/interfaces/matlab/toolbox/Contents.m.in new file mode 100644 index 000000000..54c2c3a67 --- /dev/null +++ b/interfaces/matlab/toolbox/Contents.m.in @@ -0,0 +1,9 @@ +% Cantera Toolbox +% Version @cantera_version@ +% +% Cantera is a suite of object-oriented software tools for +% problems involving chemical kinetics, thermodynamics, +% and/or transport processes. +% +% Documentation for Cantera can be found at +% http://cantera.github.io/docs/sphinx/html/index.html diff --git a/src/matlab/SConscript b/src/matlab/SConscript index 3a913c961..2c0073049 100644 --- a/src/matlab/SConscript +++ b/src/matlab/SConscript @@ -90,6 +90,12 @@ localenv.AddPreAction(target, copy_var) localenv.Depends(target, env['install_python2_action']) install('$inst_matlab_dir', target) +contents = localenv.SubstFile('#interfaces/matlab/toolbox/Contents.m', + '#interfaces/matlab/toolbox/Contents.m.in') +localenv.AddPreAction(contents, copy_var) +localenv.Depends(contents, env['install_python2_action']) +install('$inst_matlab_dir', contents) + # 'cantera_demos.m' install('$inst_matlab_dir', '#samples/matlab/cantera_demos.m') install(localenv.RecursiveInstall, '$inst_matlab_dir',