This README.txt file was generated on 16 OCT 2024 by Sam Kelly

-------------------
GENERAL INFORMATION
-------------------

These Matlab scripts and data files replicate analyze the data in Kelly et al. (2024). All input data is publicly available, although compiled data in Matlab format are include here for convenience. 

------------------------------------
SCRIPT DESCRIPTION OF main.m
------------------------------------

This script calls all other scripts.

Function dependencies: 
All other functions in this folder

Input files:
none

Output files:
none

------------------------------------
SCRIPT DESCRIPTION OF get_data.m
------------------------------------

This script combines the RBR duet, VMP, shipboard ADCP data.

Function dependencies: 
(1) sw_pres.m (seawater toolbox) 
(2) sw_dpth.m (seawater toolbox) 
(3) fw_dens.m
(4) fw_c_sound.m 

Input files:
(1) duet.mat
(2) VMP.mat
(3) sadcp.mat

Output files:
(1) data.mat

------------------------------------
SCRIPT DESCRIPTION OF get_trans.m
------------------------------------

This script organizes the observations into transects.

Function dependencies: 
(1) sw_dist.m (seawater toolbox) 
(2) sw_pres.m (seawater toolbox) 
(3) fw_dens.m
(4) fw_c_sound.m 

Input files:
(1) data.mat
(2) bathy.mat

Output files:
(1) trans.mat

------------------------------------
SCRIPT DESCRIPTION OF get_model.m
------------------------------------

This script computes the analytical model CNIW response.

Function dependencies: 
None

Input files:
(1) trans.mat

Output files:
(1) model.mat

------------------------------------
SCRIPT DESCRIPTION OF get_slab.m
------------------------------------

This script computes the slab model response.

Function dependencies: 
None

Input files:
(1) trans.mat
(2) data.mat
(3) model.mat

Output files:
(1) slab.mat

------------------------------------
FUNCTION DESCRIPTION OF fw_dens.m
------------------------------------

Compute freshwater density using Chen and Millero (1986).

Input:
(1) Salinity [psu]
(2) Temperature [C]
(3) Pressure [dbars]

Output:
(1) density [kg/m^3]

------------------------------------
FUNCTION DESCRIPTION OF fw_c_sound.m
------------------------------------

Compute freshwater sound speed using Chen and Millero (1986).

Input:
(1) Salinity [psu]
(2) Temperature [C]
(3) Pressure [dbars]

Output:
(1) sound speed [m/s]

------------------------------------
TOOLBOX DESCRIPTION of seawater 
------------------------------------

Seawater properties are computed using functions from the seawater toolbox at https://github.com/ashao/matlab/tree/master/external/seawater

SW_DPTH: Depth from pressure
SW_PRES: Pressure from depth
SW_DIST: Distance between two lat,lon coordinates

------------------------------------
DATA FILE DESCRIPTION OF VMP.mat
------------------------------------

VMP turbulence data available and documented in Kelly, "Shipboard turbulence and temperature profiles from the Near Inertial Coastal Experiment (NICE), 2017-2019" https://doi.org/10.13020/hyd7-c792

-----------------------------------
DATA FILE DESCRIPTION OF duet.mat
------------------------------------

RBR duet profiles of temperature.

Structure:
data
	fields:
	z (1 x 2000) [m] depth
	time (1 x 4121) [days] days since 1-Jan-0000 (Matlab datenum) 
	T (2000 x 4121) [C] water temperature  

-----------------------------------
DATA FILE DESCRIPTION OF sadcp.mat
------------------------------------

Shipboard ADCP and meteorological data 

Structure:
bb150
	fields:
	z (128 x 1) [m] depth
	time (12127 x 1) [days] days since 1-Jan-0000 (Matlab datenum) 
	lon (12127 x 1) [deg] longitude  
	lat (12127 x 1) [deg] latitude
	u (128 x 12127) [m/s] east velocity
	v (128 x 12127) [m/s] north velocity 
	H (12127 x 1) [m] bottom depth

Note: several unused structures and fields in sadcp.mat are not documented here.