Install MicrobeMS

From MicrobeMS Wiki
Jump to navigation Jump to search

Preface

MicrobeMS is a Matlab-based application which can be installed in two different versions (with the same functionality):

  • The stand-alone version requires installation of the MATLAB Compiler Runtime (MCR R2014a 64-bit).
  • MicrobeMS as a Matlab pcode toolbox. For this a licensed version of Matlab will be required.

Install MicrobeMS as a stand-alone application (Windows)

 

Prerequisites

MicrobeMS is Matlab based, so please verify that the MATLAB Compiler Runtime (MCR) is installed (MCR R2014a [8.3] Windows, 64-bit version). If the MCR is not installed, download the free Windows 64-bit version of the MCR for R2014a from the MathWorks web site by navigating to

       http://www.mathworks.com/products/compiler/mcr/index.html

NOTE: To run the MCR installer administrator rights may be required. For further details please refer also to the section Specification of computer configuration.

 
Installation

  • Login with your Windows user account and download / unzip the MicrobeMS archive microbems.v.0XX.setup.zip (see Downloading MicrobeMS)
  • Start microbems.v.0XX.setup.exe and follow the instructions of the installation routine. During setup, you may be asked for the Windows administrator password.
  • The license file genkey.gen is not included in the installation package. To register for a free license please send an e-mail with your name and the name of the institution you are working for to the address lasch@microbe-ms.com
  • Copy the license key into the logfile directory of MicrobeMS (version 0.82, DiaryDir, C:\Users\Public\Documents\Matlab). In case of MicrobeMS versions before v. 0.82 the license key must be copied into the HomeDir of MicrobeMS (C:\Program files\MicrobeMS\MicrobeMS). Note that administrator rights may be required in some instances.

Installation of MicrobeMS as a Matlab pcode toolbox (Windows and Linux)

 
Prerequisites

Please note that Matlab R2014a, or newer, Matlabs's Statistics and Bioinformatics toolboxes are required when using MicrobeMS as a pcode toolbox. A complete 64-bit system consisting of 64-bit hardware, a Windows, or LINUX 64-bit operating system and Matlab 64-bit are highly recommended. For further details please refer also to Specification of computer configuration.

 
Installation  

  • It is recommended to create an additional directory mass in the existing toolbox directory structure of the Matlab installation. The complete path to the toolbox directory should be similar to C:\program files\Matlab\R20XYx\toolbox\matlab\mass (R20XYa - denotes the Matlab release version) and C:\program files\Matlab\R20XYx equals the variable matlabroot. You can check this variable by typing
   >> matlabroot 
    at the Matlab command prompt. Note that the directory C:\program files\Matlab\R20XYx\toolbox\matlab should contain additional subdirectories such as \winfun oder \timefun.
  • Unpack now the zip archive pcode-microbems-v0xy.zip and copy all files into the new subdirectory ...\mass
  • Start Matlab and enter at the command prompt
   >> edit pathdef 
    The editor will now load the file pathdef.m. Add a new line with the complete path to the MicrobeMS pcode toolbox
   matlabroot,'\toolbox\matlab\mass;',... 
  • Save pathdef.m and restart Matlab
  • To run MicrobeMS call the file mass.p by typing
   >> mass 
  • The license file genkey.gen is not included in the installation package. To register for a free license please send an e-mail with your name and the name of the institution you are working for to the address lasch@microbe-ms.com
  • Don't forget to copy your personal license key genkey.gen into the directory {userpath}\Matlab (usually C:\User\YourUserName\Documents\Matlab, or alternatively into the toolbox directory ...\mass.

See also