Installation

Home > Installation

Installation

There are a number of ways of installing the ChiToolbox. Each has its relative merits depending on the access rights you have on the PC, whether you are just trying out the toolbox, or are in for the long haul.

Each of these approaches adds code to your PC and then adds the location of that code to the MATLAB path.

Good Method

This grabs a snapshot of the code and adds it to the MATLAB path.

1. Download the ChiToolbox repository as a zip file; Go to https://github.com/AlexHenderson/ChiToolbox/, click the green button marked 'Code' and select 'Download ZIP'
2. Unzip the file to a convenient location (say C:\Users\<your username>\My Documents\MATLAB\ChiToolbox for Windows users, or ~/Documents/MATLAB/ChiToolbox for Macintosh or Linux users);
3. Within the unzipped file collection is a folder called ChiToolbox. In the Current Folder browser window, right-click on ChiToolboxand select Add to Path > Selected Files and Subfolders
   .

Better Method

This approach uses MATLAB's built-in source control functionality to 'clone' the source code repository. Using this method allows you to update the code without having to download a new snapshot.

1. Create a folder in a convenient location to hold the toolbox (say C:\Users\<your username>\My Documents\MATLAB\ChiToolbox for Windows users, or ~/Documents/MATLAB/ChiToolbox for Macintosh or Linux users);

2. Navigate to this folder in MATLAB;

3. Right-click in the white space (any blank area) in the Current Folder browser, and select Source Control > Manage Files...;

4. In the Manage Files Using Source Control dialog box enter the following information:

   1. Source control integration: Git

   2. Repository path: https://github.com/AlexHenderson/ChiToolbox.git

   3. Sandbox: [this should be the folder you selected earlier, eg C:\Users\\***\My Documents\MATLAB\ChiToolbox];
      [Yes, I know the image indicates bitbucket, but please use github until I can get an updated picture]
      

   4. Click 'Retrieve' and wait for the files to be transferred to your PC.

5. In the Current Folder browser window, right-click on ChiToolbox and select Add to Path > Selected Files and Subfolders

Further information:

• Enter doc 'Clone from Git Repository' in the MATLAB Command Window

Best Method (1)

This approach installs the Git^® source control software then clones the ChiToolbox repository.

1. Install Git source control software from https://git-scm.com/;
   • During installation, ensure the git executable program is added to the operating system path (not the MATLAB path).
2. Follow the 'Better Method' above

Best Method (2)

1. Go to https://github.com/AlexHenderson/ChiToolbox/, click the green button marked 'Code', select 'Open with GitHub Desktop' and follow the instructions.

Further information:

• Enter doc 'Set Up Git Source Control' in the MATLAB Command Window
• Enter doc 'Clone from Git Repository' in the MATLAB Command Window