gael/matlab_class/gcmfaces_demo.m

function []=gcmfaces_demo();
% GCMFACES_DEMO demonstrate capabilities of the gcmfaces toolbox.
%
%expected directory structure:
%
%  gcmfaces     (codes)
%  MITprof      (codes)
%  nctiles_grid (ECCO v4 grid)
%  release1     (ECCO v4 output)
%  sample_input (additional demo material)
%
%to activate example_remap:
%
%  mkdir sample_input
%  wget ftp://mit.ecco-group.org/gforget/testcase_remap.mat
%  mv testcase_remap.mat sample_input/.
%
%to activate example_transports:
%
%  mkdir release1
%  wget --recursive ftp://mit.ecco-group.org/ecco_for_las/version_4/release1/nctiles_climatology
%  mv mit.ecco-group.org/gforget/nctiles_climatology release1/.
%  rm -rf mit.ecco-group.org
%
%to activate example_budget:
%
%  wget --recursive ftp://mit.ecco-group.org/gforget/nctiles_budget_2d
%  mv mit.ecco-group.org/gforget/nctiles_budget_2d sample_input/.
%  rm -rf mit.ecco-group.org
%
% call sequence:
%  addpath gcmfaces;
%  addpath MITprof;
%  gcmfaces_demo;

%choose verbose level
fprintf('\n Please set the amount of explanatory text display :\n');
fprintf('    0: none.\n');
fprintf('    1: comments.\n');
fprintf('    2: comments preceeded with calling sequence.\n');
fprintf('    3: same as 2, but preceeded with pause.\n');
verbose=input(' and/or type return. 0 is the default. \n');
if isempty(verbose); verbose=0; end;

fprintf('\n');

%so that gcmfaces_msg will work even before calling gcmfaces_global:
tmp1=which('gcmfaces_demo');
[PATH,NAME,EXT] = fileparts(tmp1);
addpath([PATH filesep 'gcmfaces_misc' filesep]); 
global myenv; 
myenv.issueWarnings=0;%skip warnings
myenv.verbose=verbose;%apply verbose level selected by user
%
fprintf('\n\n');
gcmfaces_msg('/////////////////////////////////////');
gcmfaces_msg('demo of gcmfaces_global and MITprof_global','// PART 0 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('/////////////////////////////////////');
fprintf('\n\n');
pause;
if myenv.verbose>0;
    gcmfaces_msg(['* gcmfaces_global: adds gcmfaces directories to path' ...
                 ' and define environment variables (see myenv)']);
end;
myenv=[];
gcmfaces_global;%this will display warning
myenv.issueWarnings=0;%skip warnings
myenv.verbose=verbose;%apply verbose level selected by user
if myenv.verbose>0;
    gcmfaces_msg('* (this warning gets resolved below by calling grid_load)');
end;

if ~isempty(which('MITprof_global'));
    MITprof_global;
    if myenv.verbose>0;
        gcmfaces_msg('* MITprof_global: adds MITprof directories to path');
    end;
end;

fprintf('\n\n');
gcmfaces_msg('/////////////////////////////////////');
gcmfaces_msg('demo of grid_load','// PART 1 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('/////////////////////////////////////');
fprintf('\n\n');
pause;
grid_load;

fprintf('\n\n');
gcmfaces_msg('/////////////////////////////////////');
gcmfaces_msg('demo of plotting routines','// PART 1 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('/////////////////////////////////////');
fprintf('\n\n');
pause;
example_display;

fprintf('\n\n');
gcmfaces_msg('///////////////////////////////////////////');
gcmfaces_msg('demo of remapping ','// PART 2 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('///////////////////////////////////////////');
fprintf('\n\n');
pause;
example_remap(0);

fprintf('\n\n');
gcmfaces_msg('///////////////////////////////////////////');
gcmfaces_msg('demo of bin averaging (gridding)','// PART 2 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('///////////////////////////////////////////');
fprintf('\n\n');
pause;
%alternatives
%example_griddata;
%example_interp;
%example_faces2latlon2faces;
fld=example_bin_average;

fprintf('\n\n');
gcmfaces_msg('///////////////////////////////////////////');
gcmfaces_msg('demo of smoothing ','// PART 2 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('///////////////////////////////////////////');
fprintf('\n\n');
pause;
example_smooth(fld);

fprintf('\n\n');
gcmfaces_msg('/////////////////////////////////////////');
gcmfaces_msg('demo of transport computations','// PART 3 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('/////////////////////////////////////////');
fprintf('\n\n');
pause;
diags=example_transports;

if ~isempty(diags);
    fprintf('\n\n');
    gcmfaces_msg('/////////////////////////////////////////');
    gcmfaces_msg('demo of transport display','// PART 3 :');
    gcmfaces_msg('please hit return','// >> ');
    gcmfaces_msg('/////////////////////////////////////////');
    fprintf('\n\n');
    example_transports_disp(diags);
end;

fprintf('\n\n');
gcmfaces_msg('/////////////////////////////////////////');
gcmfaces_msg('demo of budget computations','// PART 4 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('/////////////////////////////////////////');
fprintf('\n\n');
pause;
example_budget;

1	gforget	1.14	function []=gcmfaces_demo();
2			% GCMFACES_DEMO demonstrate capabilities of the gcmfaces toolbox.
3	gforget	1.11	%
4			%expected directory structure:
5			%
6			% gcmfaces (codes)
7			% MITprof (codes)
8			% nctiles_grid (ECCO v4 grid)
9			% release1 (ECCO v4 output)
10	gforget	1.14	% sample_input (additional demo material)
11	gforget	1.11	%
12			%to activate example_remap:
13			%
14			% mkdir sample_input
15			% wget ftp://mit.ecco-group.org/gforget/testcase_remap.mat
16			% mv testcase_remap.mat sample_input/.
17	gforget	1.10	%
18			%to activate example_transports:
19			%
20	gforget	1.11	% mkdir release1
21			% wget --recursive ftp://mit.ecco-group.org/ecco_for_las/version_4/release1/nctiles_climatology
22			% mv mit.ecco-group.org/gforget/nctiles_climatology release1/.
23			% rm -rf mit.ecco-group.org
24	gforget	1.10	%
25			%to activate example_budget:
26			%
27	gforget	1.11	% wget --recursive ftp://mit.ecco-group.org/gforget/nctiles_budget_2d
28			% mv mit.ecco-group.org/gforget/nctiles_budget_2d sample_input/.
29			% rm -rf mit.ecco-group.org
30	gforget	1.10	%
31	gforget	1.14	% call sequence:
32			% addpath gcmfaces;
33			% addpath MITprof;
34			% gcmfaces_demo;
35	gforget	1.3
36	gforget	1.10	%choose verbose level
37	gforget	1.3	fprintf('\n Please set the amount of explanatory text display :\n');
38			fprintf(' 0: none.\n');
39			fprintf(' 1: comments.\n');
40			fprintf(' 2: comments preceeded with calling sequence.\n');
41			fprintf(' 3: same as 2, but preceeded with pause.\n');
42			verbose=input(' and/or type return. 0 is the default. \n');
43			if isempty(verbose); verbose=0; end;
44
45	gforget	1.14	fprintf('\n');
46
47			%so that gcmfaces_msg will work even before calling gcmfaces_global:
48			tmp1=which('gcmfaces_demo');
49			[PATH,NAME,EXT] = fileparts(tmp1);
50			addpath([PATH filesep 'gcmfaces_misc' filesep]);
51			global myenv;
52			myenv.issueWarnings=0;%skip warnings
53			myenv.verbose=verbose;%apply verbose level selected by user
54			%
55			fprintf('\n\n');
56			gcmfaces_msg('/////////////////////////////////////');
57			gcmfaces_msg('demo of gcmfaces_global and MITprof_global','// PART 0 :');
58			gcmfaces_msg('please hit return','// >> ');
59			gcmfaces_msg('/////////////////////////////////////');
60			fprintf('\n\n');
61			pause;
62	gforget	1.3	if myenv.verbose>0;
63	gforget	1.14	gcmfaces_msg(['* gcmfaces_global: adds gcmfaces directories to path' ...
64			' and define environment variables (see myenv)']);
65			end;
66			myenv=[];
67			gcmfaces_global;%this will display warning
68			myenv.issueWarnings=0;%skip warnings
69			myenv.verbose=verbose;%apply verbose level selected by user
70			if myenv.verbose>0;
71			gcmfaces_msg('* (this warning gets resolved below by calling grid_load)');
72	gforget	1.3	end;
73	gforget	1.1
74	gforget	1.6	if ~isempty(which('MITprof_global'));
75	gforget	1.10	MITprof_global;
76			if myenv.verbose>0;
77	gforget	1.14	gcmfaces_msg('* MITprof_global: adds MITprof directories to path');
78	gforget	1.10	end;
79	gforget	1.6	end;
80
81	gforget	1.5	fprintf('\n\n');
82			gcmfaces_msg('/////////////////////////////////////');
83	gforget	1.14	gcmfaces_msg('demo of grid_load','// PART 1 :');
84			gcmfaces_msg('please hit return','// >> ');
85			gcmfaces_msg('/////////////////////////////////////');
86			fprintf('\n\n');
87			pause;
88			grid_load;
89
90			fprintf('\n\n');
91			gcmfaces_msg('/////////////////////////////////////');
92	gforget	1.8	gcmfaces_msg('demo of plotting routines','// PART 1 :');
93	gforget	1.5	gcmfaces_msg('please hit return','// >> ');
94			gcmfaces_msg('/////////////////////////////////////');
95			fprintf('\n\n');
96			pause;
97	gforget	1.12	example_display;
98	gforget	1.1
99	gforget	1.5	fprintf('\n\n');
100			gcmfaces_msg('///////////////////////////////////////////');
101	gforget	1.13	gcmfaces_msg('demo of remapping ','// PART 2 :');
102	gforget	1.5	gcmfaces_msg('please hit return','// >> ');
103			gcmfaces_msg('///////////////////////////////////////////');
104			fprintf('\n\n');
105			pause;
106	gforget	1.13	example_remap(0);
107	gforget	1.10
108	gforget	1.13	fprintf('\n\n');
109			gcmfaces_msg('///////////////////////////////////////////');
110			gcmfaces_msg('demo of bin averaging (gridding)','// PART 2 :');
111			gcmfaces_msg('please hit return','// >> ');
112			gcmfaces_msg('///////////////////////////////////////////');
113			fprintf('\n\n');
114			pause;
115			%alternatives
116			%example_griddata;
117			%example_interp;
118			%example_faces2latlon2faces;
119			fld=example_bin_average;
120
121			fprintf('\n\n');
122			gcmfaces_msg('///////////////////////////////////////////');
123			gcmfaces_msg('demo of smoothing ','// PART 2 :');
124			gcmfaces_msg('please hit return','// >> ');
125			gcmfaces_msg('///////////////////////////////////////////');
126			fprintf('\n\n');
127			pause;
128			example_smooth(fld);
129	gforget	1.1
130	gforget	1.6	fprintf('\n\n');
131			gcmfaces_msg('/////////////////////////////////////////');
132	gforget	1.8	gcmfaces_msg('demo of transport computations','// PART 3 :');
133			gcmfaces_msg('please hit return','// >> ');
134			gcmfaces_msg('/////////////////////////////////////////');
135			fprintf('\n\n');
136			pause;
137	gforget	1.9	diags=example_transports;
138	gforget	1.13
139	gforget	1.8	if ~isempty(diags);
140	gforget	1.13	fprintf('\n\n');
141			gcmfaces_msg('/////////////////////////////////////////');
142			gcmfaces_msg('demo of transport display','// PART 3 :');
143			gcmfaces_msg('please hit return','// >> ');
144			gcmfaces_msg('/////////////////////////////////////////');
145			fprintf('\n\n');
146	gforget	1.8	example_transports_disp(diags);
147			end;
148
149			fprintf('\n\n');
150			gcmfaces_msg('/////////////////////////////////////////');
151	gforget	1.6	gcmfaces_msg('demo of budget computations','// PART 4 :');
152			gcmfaces_msg('please hit return','// >> ');
153			gcmfaces_msg('/////////////////////////////////////////');
154			fprintf('\n\n');
155			pause;
156	gforget	1.9	example_budget;
157	gforget	1.1