Difference between revisions of "Install MicrobeMS"

From MicrobeMS Wiki
Jump to navigation Jump to search
Line 7: Line 7:
 
* MicrobeMS as a Matlab pcode toolbox. For this a licensed version of Matlab will be required.
 
* MicrobeMS as a Matlab pcode toolbox. For this a licensed version of Matlab will be required.
  
== Install MicrobeMS as a stand-alone application ==
+
== Install MicrobeMS as a stand-alone application (Windows) ==
 
&nbsp;<br>
 
&nbsp;<br>
  
Line 21: Line 21:
 
<b>Installation</b>  
 
<b>Installation</b>  
  
* Login with your Windows user account. If you install MicrobeMS from the Windows administrator account the MicrobeMS installation routine will copy the main configuration file ''microbems.opt'' into a directory (C:\User\Administrator\Documents\MATLAB) which is not accessible when working later with your normal Windows user account!
+
* Login with your Windows user account and download / unzip the MicrobeMS archive ''microbems.v.0XX.setup.zip'' (see [[download_MicrobeMS|Downloading MicrobeMS]])
 
 
* Download and unzip the MicrobeMS installer ''microbemssetup.zip'' (see [[download_MicrobeMS|Downloading MicrobeMS]])
 
 
      
 
      
* Start ''microbemssetup.exe'' and follow then the instructions of the installation routine. During setup, you will be asked for the Windows administrator password.  
+
* 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 [mailto:lasch@microbe-ms.com lasch@microbe-ms.com]
 
* 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 [mailto:lasch@microbe-ms.com lasch@microbe-ms.com]
 
      
 
      
* Copy the license key into the root directory of MicrobeMS (this is usually ''C:\program files(x86)\MicrobeMS\MicrobeMS'', note that administrator rights may be required)
+
* Copy the license key into the logfile directory of MicrobeMS (DiaryDir, this is usually ''C:\Users\Public\Documents\Matlab'', sometimes administrator rights may be required)
  
 
== Installation of MicrobeMS as a Matlab pcode toolbox ==
 
== Installation of MicrobeMS as a Matlab pcode toolbox ==

Revision as of 18:10, 14 January 2020

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 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 (DiaryDir, this is usually C:\Users\Public\Documents\Matlab, sometimes administrator rights may be required)

Installation of MicrobeMS as a Matlab pcode toolbox

 
Prerequisites

Please note that Matlab R2014a, or newer, the Statistics and the Bioinformatics toolboxes of Matlab are required to use MicrobeMS as a toolbox under Matlab. A full 64-bit system consisting of 64-bit hardware, a Windows 64-bit operating system and Matlab 64-bit are highly recommended. For further details please refer also to Specification of computer configuration.

 
Installation  

  • Create an additional directory \mass in the existing toolbox directory structure of your 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