This README.txt file was generated on 23 NOV 2020 by Sam Kelly

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

These Matlab scripts combine the High Resolution Empirical Tide model (HRET) data from Ed Zaron at Oregon State University with the Coupled-mode Shallow Water model (CSW) data generated from the instructions in the "CSW_config" folder. The combined data are written to matlab data files that are read by the scripts in the "plotting_scripts" folder. A copy of each output file is already included in the "plotting_scripts" folder. 

Input files needed for all scripts:
(1) The (renamed) CSW "out.mat" files for these (renamed) "csw.h" configurations: 'best', 'kappa', 'rwave', 'r4', 'HYCOM', 'GEBCO', 'FES', '10deg', '50deg', '100deg', 'Nm2', 'Nm8', 'r1', 'r2', 'r8', 'r16', 'r32'

------------------------------------
SCRIPT DESCRIPTION FOR make_coarse.m
------------------------------------

This script reads the HRET netCDF files and averages them (using the mask weights) onto a 1 degree global grid. An identical weighted average is then performed on numerous CSW simulations. The HRET energy explained by each CSW simulation is then computed.  

Input files: 
(1) HRET_v8.1_modes.nc (contact Ed Zaron)
(2) Carrere_HRET_testing.nc (contact Ed Zaron)

Output files: 
(1) coarse.mat

------------------------------------
SCRIPT DESCRIPTION FOR make_r_obs.m
------------------------------------

This script reads the HRET netCDF files and averages them (using the mask weights) onto a 1 degree global grid. An identical weighted average is then performed on numerous CSW simulations. The HRET energy explained by each CSW simulation is then computed.  

Input files: 
(1) kappa.nc (CSW input file, generated from pre-processing source code)
(2) r.nc (CSW input file, generated from pre-processing source code)
(3) delta_c2.nc (CSW input file, generated from pre-processing source code)
(4) coarse.mat

Output files: 
(1) r_obs.mat

-------------------------------------
SCRIPT DESCRIPTION FOR make_summary.m
-------------------------------------

This script compiles the global integrals for depths greater than 700 m from the "out.mat" CSW files (see above).

Input files: 
(1) coarse.mat

output files:
(1) summary_table.mat
(2) summary_r.mat