Skip to content

Installation

Jump to bottom
Eduard Kerkhoven edited this page Oct 20, 2023 · 37 revisions

Required software

  • A functional MATLAB installation (version 2016b or later).
  • Recommended: Gurobi as alternative solver.
  • Optional: COBRA Toolbox for more simulation functions.
  • Development: if new HMMs are to be trained from a KEGG FTP-dump on a Windows PC, it is required to have Windows Subsystem for Linux installed.

Installation instructions

Obtain RAVEN Toolbox

Use one of the three following ways to obtain RAVEN Toolbox: advanced / simpler / simplest.

Any problems you might encounter during installation (for instance non-working binaries when running checkInstallation) might be resolved by switching to the more advanced way of installing RAVEN.

Advanced

  • This approach is recommended, but requires git to be installed.
  • In Terminal/Command Prompt, navigate to the desired installation directory and run the following Git command:
git clone --depth=1 https://github.com/SysBioChalmers/RAVEN.git

Simpler

  • Download the latest release of the RAVEN Toolbox.
  • Extract the ZIP file to your favourite directory.
  • Follow the Install RAVEN in MATLAB instructions below.

Upgrade to latest RAVEN release

  • Close MATLAB.
  • First delete the complete RAVEN folder from your computer.
  • Optional: run pathtool to remove all mentions of the RAVEN folder and subfolders from the MATLAB path, and click Save. This prevents warning messages regarding non-existing paths when opening MATLAB anew.
  • Download the latest release of the RAVEN Toolbox.
  • Extract the ZIP file to your favourite directory.
  • Follow the Install RAVEN in MATLAB instructions below.

Simplest

  • Open Add-Ons Explorer in MATLAB: in the Home tab and the Environment section, click the Add-Ons icon.
  • Search for RAVEN Toolbox and click Add -> Add to MATLAB.
  • Follow the Install RAVEN in MATLAB instructions below.

Upgrade RAVEN as MATLAB Add-On

  • In the Home tab, click on Help > Check for Updates.
  • Click on the Update button for RAVEN Toolbox.
  • If RAVEN Toolbox is not mentioned among the Updates, it might help to restart MATLAB.

Install RAVEN in MATLAB

  • If RAVEN was obtained via MATLAB Add-Ons Explorer (the "simplest" approach), directly run in MATLAB:
checkInstallation
  • If RAVEN was cloned (the "advanced" approach) or downloaded (the "simpler" approach), first open MATLAB and run the following command, where [location] is the directory where the RAVEN files can be found:
cd('[location]/RAVEN/installation'))
checkInstallation
  • checkInstallation installs and tests general functioning of RAVEN. It recognises which solvers are installed and sets the default solver (if possible gurobi, otherwise glpk).
  • The default RAVEN solver can be changed any time with: setRavenSolver('solverName'), where 'solverName' can be either 'gurobi', 'glpk', 'soplex' or 'cobra'.
  • checkInstallation also tests various programs that are distributed with RAVEN (BLAST+, DIAMOND, HMMER). Correct functioning of these programs generally are required for making models from homology (BLAST+, DIAMOND) or making models from KEGG (HMMER). If the tests of these programs fail, they need to be re-compiled from their corresponding source codes. See the documentation for the corresponding software for more details.
  • If you plan to train HMMs based on a KEGG FTP-dump (which is rarely done, as we already distribute these for you), you should run checkInstallation(true) to also test the CD-HIT and MAFFT binaries. If you run MATLAB on Windows, you should have Windows Subsystem for Linux installed.

Optional software

Solvers

RAVEN can function with various solvers. Gurobi is recommended, but other solvers might be suitable to fit different requirements:

Solver FBA (solveLP) MILPs (fillGaps, tINIT) Speed (solveLP) License Distributed with RAVEN Installation Comments
glpk Yes No 1x Open-source Yes Not required Default alternative.
soplex Yes Yes 0.33x Open-source Yes (Windows only) SCIP Optimization Suite. Location of SoPlex binary should be added to the system PATH. Solves with "iterative refinement", prevents solution instability due to rounding errors, which can be a concern if fluxes range across many orders of magnitude.
gurobi Yes Yes 4.2x Commercial No Instructions. Free academic license available. Recommended alternative.
cobra Yes ? ? ? No Instructions. Exact details depend which solver was enabled in COBRA Toolbox with changeCobraSolver.

Gurobi

  • Download and install Gurobi v7.5+ to your favourite location.
  • Make sure you retrieve and setup your Gurobi License. If suitable, academic license are offered for free.
  • Pay attention at what location the license file is stored, the default location is recommended.
  • To install Gurobi in MATLAB, follow the instructions for Windows, Mac or Unix.
  • Make sure that MATLAB remembers the Gurobi installation for next time, by running savepath.

COBRA Toolbox

  • To gain access to functions from the COBRA Toolbox and/or use whatever solver was setup in COBRA Toolbox, follow installation instructions provided here.
  • To use COBRA-specific functions on a model, you are advised to first change the model into COBRA-format, using modelCobra=ravenCobraWrapper(model).
  • To use COBRA-specified solvers (e.g. open-source GLPK solver), configure COBRA and RAVEN with the following commands:
changeCobraSolver('glpk')
setRavenSolver('cobra')
Clone this wiki locally