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_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 interpolation and remapping ','// PART 2 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('///////////////////////////////////////////');
fprintf('\n\n');
pause;
example_interp;

fprintf('\n\n');
gcmfaces_msg('///////////////////////////////////////////');
gcmfaces_msg('demo of bin averaging data sample to grid','// PART 2 :');
gcmfaces_msg('please hit return','// >> ');
gcmfaces_msg('///////////////////////////////////////////');
fprintf('\n\n');
pause;
fld=example_bin_average;

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