edit readme

Author: irenavankova

README.md

@@ -1 +1,23 @@
-# ApRES_processing
+# ApRES_processing
+
+A series of scripts that can be used to process ApRES data. The outputs are
+ 
+* complex signal as a function of range for each shot (standard processing)
+* displacement time series for each range (for a specified bin width)
+* displacement time series of the basal reflector (using 2 different techniques)
+
+Instructions are in the following:
+ct_processing_sequence_V4.m
+
+
+For more information see:
+
+Vaňková, I., K. W. Nicholls, H. F. J. Corr, K. Makinson, and P. V. Brennan (2020), Observations of Tidal Melt and Vertical Strain at the Filchner-Ronne Ice Shelf, Antarctica, Journal of Geophysical Research: Earth Surface, 125(1), doi:10.1029/2019JF005280
+
+The package is based on scripts developed by: 
+
+Stewart, C. L. (2018), Ice-ocean interactions beneath the north-western Ross Ice Shelf, Antarctica, Thesis, University of Cambridge, doi:10.17863/CAM.21483
+
+Nicholls, K. W., H. F. Corr, C. L. Stewart, L. B. Lok, P. V. Brennan, and D. G. Vaughan (2015), A ground-based radar for measuring vertical strain rates and time-varying basal melt rates in ice sheets and shelves, Journal of Glaciology, 61(230), 1079–1087, doi: 10.3189/2015JoG15J073
+
+

example_site/ex01/ct_site_param_processing.m

@@ -5,28 +5,20 @@
 %--------------------------------------------------------------
 
 % Directory with files to be processed
-cfg.myDirPath = '/Volumes/GoogleDrive/My Drive/Research/DOVuFRIS/Fris_Apres/Fris_data/data2test_processing/ex01'; 
+
+cfg.myDirPath = '/path_to_data_folder'; 
+%cfg.myDirPath = '/Volumes/GoogleDrive/My Drive/Research/DOVuFRIS/Fris_Apres/Fris_data/data2test_processing/ex01'; 
 
 cfg.myDir = [cfg.myDirPath '/**/'];
 
 cfg.output_mat_file_name = 'ex01';
 cfg.output_mat_fname_tseries_fine = [cfg.output_mat_file_name '_ts_fine'];
 cfg.output_mat_fname_tseries_coarse = [cfg.output_mat_file_name '_ts_coarse'];
 
-% % Bad burst option (if not define defaults are assigned)
-% % MANUAL SELECT
-% cfg.bad_burst.filename = [];
-% cfg.bad_burst.burst_in_file = [];
-% cfg.bad_burst.chirpselect = [];
-% % APPROACH
-% cfg.chirp_quality_test.type = 'none';
-% cfg.chirp_quality_test.range = [];
-% cfg.chirp_quality_test.tol_num_over = [];
-% 
-% % Subset of bursts limited by first and last file to consider
-% cfg.burst_subset_end_files = 0;
-% cfg.burst_subset_first_file = [];
-% cfg.burst_subset_last_file = [];
+% If want only a subset of files in the directory, uncomment the following and provide the first and last files here:
+%cfg.burst_subset_end_files = 1;
+%cfg.burst_subset_first_file = 'DATA2016-01-16-1428.DAT';
+%cfg.burst_subset_last_file = 'DATA2016-01-17-2328.DAT';
 
 % Subset of bursts to choose (set options to 0 to process all bursts)
 cfg.first_burst_infile_only = 0; %Set to 1 if want only first burst in each file

example_site/ex01/ct_site_param_processing_first_look.m

@@ -2,7 +2,7 @@
 
 cfg = ct_site_param_processing;
 
-% Subset of bursts limited by first and last file to consider
+% Provide 2 filenames from which the first chirp will be plotted and compared
 cfg.burst_subset_end_files = 1;
 cfg.burst_subset_first_file = 'DATA2016-01-16-1428.DAT';
-cfg.burst_subset_last_file = 'DATA2016-01-25-1728.DAT';
+cfg.burst_subset_last_file = 'DATA2016-01-17-2328.DAT';