readme.txt

guiBathy Source Code

This repository contains the source code and compiled executable for guiBathy. Users can either 
run the software as a stand alone executable (without a Matlab license) or edit/run software in Matlab.

Installation Instructions: Options 1-4. 

1. Edit/Run Source Code (Requires Matlab 2019B+, License and toolboxes)
>> Clone entire repository, make the top level directory your current workspace. Open uastoolbox.app. 
>> Requires Statistics and Machine Learning, Image Processing, and ComputerVision Toolboxes.

2. Run as Matlab app (Requires Matlab 2019B+, Toolboxes, and Licenses)
>> Download  and run compiled_version/guiBathy_mat.mlappinstall
>> Requires Statistics and Machine Learning, Image Processing, and ComputerVision Toolboxes.

3. Run Executable without MATLAB or MATLAB Runtime installed (Does not require Matlab 2019B+, License, or toolboxes)
>> Download compiled_version/guiBathy/for_redistribution/guiBathy_with_runtime_installer.exe
>> Follow Instructions
NOTE: You will need administrator rights to run the MATLAB Runtime installer. Also it is a big file and takes a while to download/install. 

4. Run Executable with MATLAB  Runtime already installed (Requires MATLAB 2020b Runtime v9.9, no toolboxes, no licenses)
>> Download compiled_version/guiBathy/for_redistribution_files_only/guibathy.exe and run. 


NOTE: To run guibathy.exe you will need the MATLAB 2020b Runtime v9.9 installed regardless if a licensed version of MATLAB is installed.
If you prefer not to run the .exe, use options 1-2. However this requires licenses and toolboxes. 

NOTE: In order to run properly, your computer display refresh rate must be ~60Hz. Can be changed via Settings->Display->Advanced Display Settings -->Refresh Rate.


For use, please cite:
Bruder, B. L., Brodie, K. L., Hesser, T. J., Spore, N. J., Farthing, M. W., Geheran, M. P., & Renaud, A. D. (2021). guiBathy: A Graphical 
User Interface to Estimate Nearshore Bathymetry from Hovering Unmanned Aerial System Imagery.