MIA Toolbox Installation: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
(New page: __TOC__ ==Installing MIA_Toolbox== MIA_Toolbox is delivered as a Windows Installer (.exe for Windows only) or as a compressed ZIP file (all platforms). Installation is a two-part process ...)
 
No edit summary
 
(9 intermediate revisions by 3 users not shown)
Line 6: Line 6:
MATLAB path.
MATLAB path.
===System Requirements===
===System Requirements===
* MATLAB 6.5 or greater.
* Compatible with any version of Matlab released within 5 years of the release of this product.  For example the oldest version of Matlab guaranteed to be fully compatible with MIA_Toolbox version 3.0.3 (released in 2016) would be Matlab 2011.
* Current PLS_Toolbox Release.  
* Current PLS_Toolbox Release.  
* 5 MB of disk space.  
* 50 MB of disk space.
 
===Using the MIA_Toolbox Windows Installer===
===Using the MIA_Toolbox Windows Installer===
It is recommended that Windows users use the MIA_Toolbox Windows Installer.  
It is recommended that Windows users use the MIA_Toolbox Windows Installer.  
Line 19: Line 20:
# '''Run <code>miainstall</code>''' <br>For MATLAB to find MIA_Toolbox, the directories that contain the toolbox files must be added to the MATLAB search path (except the @DATASET folder). <br>'''Note''': If you are familiar with installing toolboxes purchased from The MathWorks, this process is slightly different. TMW installers typically are able to set the path automatically.) <br>Start MATLAB and follow these steps:
# '''Run <code>miainstall</code>''' <br>For MATLAB to find MIA_Toolbox, the directories that contain the toolbox files must be added to the MATLAB search path (except the @DATASET folder). <br>'''Note''': If you are familiar with installing toolboxes purchased from The MathWorks, this process is slightly different. TMW installers typically are able to set the path automatically.) <br>Start MATLAB and follow these steps:
#* Start MATLAB and use the Current Directory toolbar to navigate to the MIA_Toolbox directory created in Step One.  
#* Start MATLAB and use the Current Directory toolbar to navigate to the MIA_Toolbox directory created in Step One.  
#* Once MIA_Toolbox is the current directory type evriinstall at the command line (in the COMMAND WINDOW): <pre>>> miainstall</pre>. MIAINSTALL will add MIA_TOOLBOX to the MATLAB path, check for any installation problems, and output results to the command window.
#* Once MIA_Toolbox is the current directory type evriinstall at the command line (in the COMMAND WINDOW): <pre>>> miainstall</pre>
#* MIAINSTALL will add MIA_TOOLBOX to the MATLAB path, check for any installation problems, and output results to the command window.
 
===Using EVRIINSTALL===
# Place the MIA_Toolbox main folder in the same parent folder as PLS_Toolbox.
# Run EVRIINSTALL: <pre>>> evriinstall</pre> The evriinstall script will search for and install any Eigenvector products located in the PLS_Toolbox parent director.
 
===Using A Demo Version===
If you are demoing both PLS_Toolbox and MIA_Toolbox installation will proceed as described above.
 
If you are using a demo version of MIA_Toolbox with a full version of PLS_Toolbox you will receive a license warning after running <code>miainstall</code>. Run <code>evriclearlicense</code> and a dialog box will appear where you can enter the demo license code. When the demo period has expired you will need to clear the the license and enter your full PLS_Toolox license. The MIA_Toolbox demo will cease to work at this point and you can delete the folder.

Latest revision as of 10:52, 26 July 2021

Installing MIA_Toolbox

MIA_Toolbox is delivered as a Windows Installer (.exe for Windows only) or as a compressed ZIP file (all platforms). Installation is a two-part process of copying and decompressing files into a local folder and then adding those files to your MATLAB path.

System Requirements

  • Compatible with any version of Matlab released within 5 years of the release of this product. For example the oldest version of Matlab guaranteed to be fully compatible with MIA_Toolbox version 3.0.3 (released in 2016) would be Matlab 2011.
  • Current PLS_Toolbox Release.
  • 50 MB of disk space.

Using the MIA_Toolbox Windows Installer

It is recommended that Windows users use the MIA_Toolbox Windows Installer.

  1. Copy the .exe file to your Desktop (or other suitable local location).
  2. Double click the icon and follow the instructions. Be sure to verify the location of the installation folder; by default it will be the "toolbox" folder of your current MATLAB installation.
  3. When the Installer has completed a message will display at the Matlab command line.

Manually Installing MIA_Toolbox from ZIP File (all other platforms)

  1. File Extraction
    Decompress the MIA_Toolbox ZIP file and move it to the MATLAB "toolbox" folder (e.g. C:\Program Files\MATLAB\R2006a\toolbox).
    Note: For those who already have a version of MIA_Toolbox installed, be sure the folders do not have the same name (by default they should not). Rename your existing copy of MIA_Toolbox if necessary.
  2. Run miainstall
    For MATLAB to find MIA_Toolbox, the directories that contain the toolbox files must be added to the MATLAB search path (except the @DATASET folder).
    Note: If you are familiar with installing toolboxes purchased from The MathWorks, this process is slightly different. TMW installers typically are able to set the path automatically.)
    Start MATLAB and follow these steps:
    • Start MATLAB and use the Current Directory toolbar to navigate to the MIA_Toolbox directory created in Step One.
    • Once MIA_Toolbox is the current directory type evriinstall at the command line (in the COMMAND WINDOW):
      >> miainstall
    • MIAINSTALL will add MIA_TOOLBOX to the MATLAB path, check for any installation problems, and output results to the command window.

Using EVRIINSTALL

  1. Place the MIA_Toolbox main folder in the same parent folder as PLS_Toolbox.
  2. Run EVRIINSTALL:
    >> evriinstall
    The evriinstall script will search for and install any Eigenvector products located in the PLS_Toolbox parent director.

Using A Demo Version

If you are demoing both PLS_Toolbox and MIA_Toolbox installation will proceed as described above.

If you are using a demo version of MIA_Toolbox with a full version of PLS_Toolbox you will receive a license warning after running miainstall. Run evriclearlicense and a dialog box will appear where you can enter the demo license code. When the demo period has expired you will need to clear the the license and enter your full PLS_Toolox license. The MIA_Toolbox demo will cease to work at this point and you can delete the folder.