Getting started

2.1 Requirements

To use GISMO you will need MATLAB (we recommend version 2014a or above, including the Signal Processing and Statistics toolboxes). Some of the code is compatible with Octave (and earlier versions of MATLAB), but this is not guaranteed. Note that on MacOS-X, Octave does not yet support "classdef".

2.2 Downloading

If you use the version-control system git, (we highly recommend this) you can clone the GISMO repository with:

git clone git@github.com:geoscience-community-codes/GISMO.git

Otherwise, you can download GISMO as a zip file or a tar ball and extract it.

Either way, you should end up have a local directory 'GISMO'.

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

/home/username/src/GISMO 

on a Linux/Mac, or

\Users\username\src\GISMO 

on Windows

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

2.3 Installation

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

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/GISMO')
startup_GISMO

Save this file, then execute it:

>> startup

If you have installed GISMO correctly, the command:

>> which Catalog

should return:

/home/username/src/GISMO/classes/@Catalog/Catalog.m

2.4 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.