Getting started

2.1 Requirements

To use GISMO you will need MATLAB (at least which version?). Some of the code might be compatible with Octave, but this has not been tested.

2.2 Downloading

If you use the version-control system git, you can clone the GISMO repository with:

git clone git@github.com:giseislab/gismotools.git

Otherwise, you can download the Zip file and unzip it.

Either way, you should now have a local directory 'gismotools'.

Move the gismotools directory to somewhere sensible, e.g.:

/home/username/src/gismotools 

on a Linux/Mac, or

\Users\username\src\gismotools 

on Windows

from now on we will assume the directory is /home/username/src/gismotools

2.3 Installation

Let's assume your copy of GISMO is stored locally on your filesystem as /home/username/src/gismotools.

Start MATLAB. At the MATLAB prompt (>>), type:

>> edit startup.m

This file may or may not already exist. If it does - add these two lines to the end. If not, the file will be blank, so just add these two lines:

addpath('/home/username/src/gismotools/GISMO')
startup_GISMO

Save this file, then execute it:

>> startup

If you have installed GISMO correctly, the command:

>> which readCatalog

should return:

/home/username/src/gismotools/GISMO/classes/catalog/readCatalog.m

2.4 Testing your installation

2.5 Stay informed

If you are using GISMO we strongly recommend you join the [GISMO Users mailing list] (https://groups.google.com/forum/?hl=en#!forum/gismotools) group for advice and updates. Any questions relating to GISMO can be posted there.