Home > matlab > makesimulation.m

makesimulation

PURPOSE ^

Make ACADO simulation environment. Run the command 'makesimulation' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/

SYNOPSIS ^

function [ ] = makesimulation( varargin )

DESCRIPTION ^

  Make ACADO simulation environment. Run the command 'makesimulation' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/

  Usage:
   >>makesimulation                    Make changed files only, no debugging, no cleaning
   >>makesimulation clean              Clean all object and mex files
   >>makesimulation debug              Make changed files only in debug mode
   >>makesimulation all                Force all files to be maked again
   >>makesimulation all debug          Force all files to be maked again in debug mode
   >>makesimulation clean all          First clean, then make all files
   >>makesimulation clean all debug    First clean, then make all files in debug mode
  
  All information regarding installation available at http://www.acadotoolkit.org/matlab

  You need to setup mex before you can run this make script. Run 
   >>mex -setup
  in your console if you haven't used mex yet. 

  When using Windows, we encourage you to install Microsoft Visual C++
  (express) compiler first. After installation, run "mex -setup" and
  select the Microsoft Visual C++ compiler as your default compiler. This
  compiler can be download free of charge on
  http://www.microsoft.com/Express/VC/.

  When running Linux/Mac OS, select the GCC compiler. 


  After having run makeocp, all ACADO files are compiled and stored in the bin
  directory. Your paths are also altered to reference the ACADO folders.
  If you close are reopen Matlab you need to rerun this file because your
  path settings will be lost. As long as you do not delete the content of
  the bin folder, this should only take a few seconds because all files
  are unchanged. If you prefer not to rerun this file. Run 
    >>savepath
  in your console. This will store the current path for future sessions.


  Example:
   >>makesimulation; 
   <hit enter and wait for the compilation to end. This will take a few minutes>

  see also make, makeintegrators, makeocp, makemex

  Licence:
    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)

    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
    Developed within the Optimization in Engineering Center (OPTEC) under
    supervision of Moritz Diehl. All rights reserved.

    ACADO Toolkit is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 3 of the License, or (at your option) any later version.

    ACADO Toolkit is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with ACADO Toolkit; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

    \author David Ariens
    \date 2010

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [ ] = makesimulation( varargin )
0002 %  Make ACADO simulation environment. Run the command 'makesimulation' directly within the directory <ACADOtoolkit-inst-dir>/interfaces/matlab/
0003 %
0004 %  Usage:
0005 %   >>makesimulation                    Make changed files only, no debugging, no cleaning
0006 %   >>makesimulation clean              Clean all object and mex files
0007 %   >>makesimulation debug              Make changed files only in debug mode
0008 %   >>makesimulation all                Force all files to be maked again
0009 %   >>makesimulation all debug          Force all files to be maked again in debug mode
0010 %   >>makesimulation clean all          First clean, then make all files
0011 %   >>makesimulation clean all debug    First clean, then make all files in debug mode
0012 %
0013 %  All information regarding installation available at http://www.acadotoolkit.org/matlab
0014 %
0015 %  You need to setup mex before you can run this make script. Run
0016 %   >>mex -setup
0017 %  in your console if you haven't used mex yet.
0018 %
0019 %  When using Windows, we encourage you to install Microsoft Visual C++
0020 %  (express) compiler first. After installation, run "mex -setup" and
0021 %  select the Microsoft Visual C++ compiler as your default compiler. This
0022 %  compiler can be download free of charge on
0023 %  http://www.microsoft.com/Express/VC/.
0024 %
0025 %  When running Linux/Mac OS, select the GCC compiler.
0026 %
0027 %
0028 %  After having run makeocp, all ACADO files are compiled and stored in the bin
0029 %  directory. Your paths are also altered to reference the ACADO folders.
0030 %  If you close are reopen Matlab you need to rerun this file because your
0031 %  path settings will be lost. As long as you do not delete the content of
0032 %  the bin folder, this should only take a few seconds because all files
0033 %  are unchanged. If you prefer not to rerun this file. Run
0034 %    >>savepath
0035 %  in your console. This will store the current path for future sessions.
0036 %
0037 %
0038 %  Example:
0039 %   >>makesimulation;
0040 %   <hit enter and wait for the compilation to end. This will take a few minutes>
0041 %
0042 %  see also make, makeintegrators, makeocp, makemex
0043 %
0044 %  Licence:
0045 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0046 %
0047 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0048 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0049 %    Developed within the Optimization in Engineering Center (OPTEC) under
0050 %    supervision of Moritz Diehl. All rights reserved.
0051 %
0052 %    ACADO Toolkit is free software; you can redistribute it and/or
0053 %    modify it under the terms of the GNU Lesser General Public
0054 %    License as published by the Free Software Foundation; either
0055 %    version 3 of the License, or (at your option) any later version.
0056 %
0057 %    ACADO Toolkit is distributed in the hope that it will be useful,
0058 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0059 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0060 %    Lesser General Public License for more details.
0061 %
0062 %    You should have received a copy of the GNU Lesser General Public
0063 %    License along with ACADO Toolkit; if not, write to the Free Software
0064 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0065 %
0066 %    \author David Ariens
0067 %    \date 2010
0068 %
0069 
0070     if verLessThan('matlab', '7.6.0')
0071         fprintf('\n--------------------------------------------------------\nWARNING: You are using a non supported Matlab version.\n-------------------------------------------------------- \n\nThe optimization interface (OCP, MPC, parameter estimation...) \nonly supports R2008a or newer. \nThe integrators can be ran on earlier versions. \nUse makeintegrators instead.\n\n');
0072         error('Stopping make...');
0073     end
0074 
0075     
0076 if (nargin ~= 0)
0077     makehelper(3, {}, varargin);
0078 else
0079     makehelper(3, {});
0080 end
0081 
0082 end

www.acadotoolkit.org/matlab
Generated on Tue 01-Jun-2010 20:14:12 by m2html © 2005