This README.txt file was generated on 10 JAN 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_water_level.m
------------------------------------

This script loads raw water level files and combines them into a single matlab file. It is included to show how 1970-2019.mat was generated and it not intended to be run because the raw data is not included. 

Function dependencies: 
N/A

Input files:
N/A

Output files:
(1) 1970-2019.mat

------------------------------------
SCRIPT DESCRIPTION OF get_modes.m
------------------------------------

This script computes the rotating basin modes using PR.m. It is included to show how modes.mat was generated and it not intended to be run. It uses Smith and Sandwell bathymetry (https://topex.ucsd.edu/marine_topo/)

Function dependencies: 
N/A

Input files:
N/A

Output files:
(1) modes.mat (in plotting_scripts folder)

------------------------------------
SCRIPT DESCRIPTION OF get_met.m
------------------------------------

This script reads raw meteorological data from the Lake Superior buoys (https://www.ndbc.noaa.gov/) and combines it into a single matlab file. It is included to show how met.mat was generated and it not intended to be run. 

Function dependencies: 
N/A

Input files:
N/A

Output files:
(1) met.mat (in plotting_scripts folder)

------------------------------------
SCRIPT DESCRIPTION OF process_lake_level.m
------------------------------------

This script reads raw water level data and removes mean water level and tides. It then computes CEOFs shapes and amplitudes.

Function dependencies: 
none

Input files:
(1) 1970-2019.mat (in plotting_scripts folder)

Output files:
(1) 1970-2019_v2.mat (in plotting_scripts folder)

------------------------------------
SCRIPT DESCRIPTION OF analyze_seiche.m
------------------------------------

This script computes statistics on seiche variance. 

Function dependencies: 
none 

Input files:
(1) 1970-2019_v2.mat (in plotting_scripts folder)

Output files:
(1) 1970-2019_v2.mat (in plotting_scripts folder)

------------------------------------
SCRIPT DESCRIPTION OF analyze_A.m
------------------------------------

This script computes statistics on seiche amplitudes by month. 

Function dependencies: 
none 

Input files:
(1) 1970-2019_v2.mat (in plotting_scripts folder)

Output files:
(1) 1970-2019_v2.mat (in plotting_scripts folder)

------------------------------------
DATA FILE DESCRIPTION OF 1970-2019.mat
------------------------------------

Raw lake level data as collected from US and Canadian tide gauge databases  (https://tidesandcurrents.noaa.gov/water_level_info.html and https://www.tides.gc.ca/en/great-lakes-tide-and-water-level-gauges)

Structure:
data
	fields:
	name (1 x 8) Station names
	num (1 x 8) Station numbers
	ID (1 x 8) Station IDs
	lon (1 x 2374) [deg] longitude
	lat (1 x 1157) [deg] latitude 
	yday (438288 x 1) [days] days since 00:00:00 1-Jan-1970
	eta (438288 x 8) [m] lake level (de-trended and de-tided)