# CoFFee - an open-source Matlab toolbox for multibeam sonar data processing
# Note: outdated..

To allow Matlab to find the data and functions composing this toolbox, you need to add the toolbox's folder and subfolders to Matlab's path.

1. Ensure the current folder is this toolbox root folder (the one containing this README.md file).

2. Run the following command to add the toolbox folder and its subolders to Matlab's path:

`addpath(genpath(cd));`

The toolbox is now ready to use for the current MATLAB session.

3. If you want to save this for all future MATLAB sessions, you can save the path by running the command:

`savepath;`

NOTE: Doing so will alter your path for future sessions. The MATLAB commands `restoredefaultpath;` followed by `savepath;` can be used to restore MATLAB's default path although you will then lose any modifications made to the default path prior to adding the path to this toolbox.

# *CoFFee*

Matlab toolbox for multibeam sonar data processing

## Description

*CoFFee* is a free and open-source MATLAB library/toolbox for parsing, visualizing, and processing multibeam sonar data processing.

**This is currently a pre-release of version 2.0, so use at your perils!**

## Getting Started

#### Dependencies

* [MATLAB R2020b](https://au.mathworks.com/products/get-matlab.html) and a few required toolboxes (to list).

### Installing and using

* Clone the repository.
* Add the toolbox's folder and subfolders to the Matlab's path by starting your scripts with:

```
coffeeFolder = 'C:\my\path\to\CoFFee';
addpath(genpath(coffeeFolder));
```

Update readme for cff v2 prerelease
Update readme for cff v2 prerelease