This folder and contents comprise the data and methods used to produce the results as presented in "Comparative evaluation of volumetric current measurements in a tidally-dominated, coastal setting with an emphasis on float swarms," written by Trevor Harrison (University of Washington), Kristen M. Thyng (Texas A&M University), and Brian Polagye (Univeristy of Washington). 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The outputs of the hydrodynamic simulation of Admiralty Inlet, on which the evaluations were based, are separately available at http://pong.tamu.edu/~kthyng/froude/ai65/OUT/. 
For more information on the files used, see the README file in the ./data/site_data subfolder. 
For the toolbox to function, a potential user must download the data from that resository, placing the files in the ./data/site_data subfolder. 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The basic workflow of the Comparative Evaluation Toolbox follows:
1. launchCompEval - establishes settings used throughout the toolbox. 

2a. ./src/runCoreCompEval - this is the core script that performs the comparative evaluation of volumetric flow reconstruction for all devices at a particular location within the domain, for a particular tidal cycle. Location options are as listed in ./data/locations and tidal options are 'Spring' and 'Neap.' Additional locations and time periods could be defined by a future user, but would require downloading the relevant data series from the site data repository defined above. 

2b. ./src/runScalarFieldReconstruction - simliar to runCoreCompEval, this script evaluates the ability of the float swarm to provide scalar field (temperature, salinity) reconstructions. 

3. Plotting results:
PAPER FIGURE 				FIGURE FILE NAME		GENERATING FUNCTION/SCRIPT
Fig. 1: Admialty Inlet domain		LocationMap 			./apps/plotLocations.m
Fig. 2: Tidal cycles			ZetaTimeSeries	 		./src/evaluation/plotting/plot_ZetaTimeSeries.m;
Fig. 3: Deployment stencil		Stencil_Allplatforms		./platforms/plotAllStencil.m
Fig. 4: Evaluation geometry		Evaluation_Planes 		./platforms/plotEvaluationPlanes.m
Fig. 5: ADCP Beam Coordinates		-- From Richmond et al. 2015 --	---- N/A ----
Fig. 6: Volumetric reconstruction	FigR1_ReconstructionSummary 	./src/evaluation/plotting/plot_ReconstructionExample_v3.m
Fig. 7: Time-blurring error		TimeBlurringError 		./src/evaluation/plotting/plot_ErrorTimeBlurring.m
Fig. 8: MAD distribution by location 	StatDist_AllLoc_Umag 		./src/evaluation/plotting/plot_LocationTrends.m
Fig. 9: Generalized perfromance trends	CompEval_FullyReduced3Comp 	./src/evaluation/plotting/plot_OverallStats.m
Fig. 10: Salinity reconstruction	FigR5_Scalar 			./src/evaluation/plotting/plot_ScalarFieldreconstruction_v2.m
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most scripts and functions should have sufficient, self-contained documentation as to prove understandable to a user generally familiar with MATLAB. The toolbox was last run using MATLAB 2018b and there are no known errors to report. We caution that functions from additional toolboxes (specifically the Mapping Toolbox) may be required. 

For additional information or guidance, please contact trevor.w.harrison[at]gmail.com
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~