vizan-client-matlab

A Matlab client for VizAn REST server

Table of Contents

Installation

vizan-client-matlab is available on Linux/macOS and Windows and supports MATLAB R2016b and higher.

You can use MATLAB toolbox file. It is found under Releases.

Or you can install toolbox manually. First, clone repo:

$ git clone https://github.com/lv-csbg/vizan-client-matlab.git
$ matlab -nodesktop -nojvm -r "addpath(genpath('vizan-client-matlab')); exit;"

Or in MATLAB change working directory to git directory and:

addpath(genpath(pwd))

Local Web server

For local server you need to install Docker . On Linux also you should perform post-installation steps . To download the needed docker image enter this command into Terminal:

$ docker pull lvcsbg/tools:vizan-rest-server-slim

And to run local server directly from MATLAB:

% To start server
server = initVizAnLocalServer
% To stop server
delete(server)

Usage

With local server running there is no need to provide url, so :

% To start server
server = initVizAnLocalServer
% When using local server 'url' parameter is not needed
% exampleHttpResponse = visualise('model.json','model_map.svg','fba_result.svg', 'FBA');
% 'model.json' - filename of a model;
% 'model_map.svg' - filename of a map, created based on model, explained in VizAn tutorial;
% 'fba_result.svg' - filename for result visualisation;
% 'FBA' - type of visualisation;
% exampleHttpResponse - returns HTTP response received from server, for info/debug purposes.
res = visualise('iML1515.json','E_coli_source.svg','my_matlab_output_fba.svg', 'FBA');
% To stop server
delete(server)

Development

To install the development version from Github:

git clone https://github.com/lv-csbg/vizan-client-matlab.git
cd vizan-client-matlab

License

vizan-client-matlab is distributed under the terms of GPL v3 License

docker_server module is also distributed under the terms of MIT License

lv-csbg / vizan-client-matlab Goto Github PK