matlab_class/gcmfaces_diags/diags_driver.m

function []=diags_driver(dirModel,dirMat,years,setDiags,doInteractive);
%object:       compute the various cost and physics
%              diagnosits from model output
%input:        dirModel is the directory containing 'diags/' or 'nctiles/'
%              dirMat is the directory where diagnostics results will be saved
%                     if isempty(dirMat) then [dirModel 'mat/'] is used by default
%              years (vector) that states years (or sets of 12 records) to compute
%                     if years=[1:4] then the first 4 years are computed
%(optional)    setDiags further specifies physical diags to be computed
%                     if setDiags='A' then one set of diags ('A') is computed
%                     By default three sets of diags ('A','B','C') are computed.
%(optional)    doInteractive=1 allows users to specify parameters interactively
%                     doInteractive = 0 (default) uses ECCO v4 parameters
%                     and omits budgets and model-data misfits analyses
%
%notes : eventually should also use dirMat, dirTex interactively for years=[];

gcmfaces_global; global myparms;

%%%%%%%%%%%%%%%
%pre-processing
%%%%%%%%%%%%%%%

if isempty(who('doInteractive')); doInteractive=0; end;
myswitch=diags_pre_process(dirModel,dirMat,doInteractive);

dirModel=[dirModel '/'];
if isempty(dirMat); dirMat=[dirModel 'mat/']; else; dirMat=[dirMat '/']; end;

%%%%%%%%%%%%%%%%%%%%
%set loop parameters
%%%%%%%%%%%%%%%%%%%%

years=years-myparms.yearFirst+1;
if myparms.diagsAreMonthly;
    years=years(years<=myparms.recInAve(2)/12);
    lChunk=12;
end;
if myparms.diagsAreAnnual;
    years=years(years<=myparms.recInAve(2));
    lChunk=1;
end;

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%now do the selected computation chunk:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

if ~isempty(who('setDiags'));

    %physical diagnostics
    for myYear=years;
        diags_select(dirModel,dirMat,setDiags,lChunk,myYear);
    end;
    
    %need profiles, cost, ctrl, budget, 'B' to work in this way too
    %need fix for : ~myswitch.doBudget and setDiags='D' or setDiags{1}='D'
    
else;
    
    for myYear=years;
        
        %standard physical diagnostics :
        diags_select(dirModel,dirMat,'A',lChunk,myYear);
        if myYear==years(1);
            recInAve=[myparms.recInAve(1):myparms.recInAve(2)];
            diags_select(dirModel,dirMat,'B',1,recInAve);
        end;
        diags_select(dirModel,dirMat,'C',lChunk,myYear);
        
        %budgets :
        if myswitch.doBudget;
            for kk=myparms.budgetList;
                diags_select(dirModel,dirMat,{'D',kk},lChunk,myYear);
            end;
        end;
        
        %model-data misfits :
        %  in situ profiles fit
        if myswitch.doProfiles&myYear==years(1); insitu_diags(dirMat,1); end;
        %  altimeter fit
        if myswitch.doCost&myYear==years(1); cost_altimeter(dirModel,dirMat); end;
        %  other cost terms
        if myswitch.doCost&myYear==years(1); cost_sst(dirModel,dirMat,1); end;
        if myswitch.doCost&myYear==years(1); cost_bp(dirModel,dirMat,1); end;
        if myswitch.doCost&myYear==years(1); cost_seaicearea(dirModel,dirMat,1); end;
        %  controls
        if myswitch.doCtrl&myYear==years(1); cost_xx(dirModel,dirMat,1); end;
        
    end;
    
end;

1	gforget	1.6	function []=diags_driver(dirModel,dirMat,years,setDiags,doInteractive);
2	gforget	1.1	%object: compute the various cost and physics
3			% diagnosits from model output
4	gforget	1.6	%input: dirModel is the directory containing 'diags/' or 'nctiles/'
5			% dirMat is the directory where diagnostics results will be saved
6			% if isempty(dirMat) then [dirModel 'mat/'] is used by default
7			% years (vector) that states years (or sets of 12 records) to compute
8			% if years=[1:4] then the first 4 years are computed
9			%(optional) setDiags further specifies physical diags to be computed
10			% if setDiags='A' then one set of diags ('A') is computed
11			% By default three sets of diags ('A','B','C') are computed.
12			%(optional) doInteractive=1 allows users to specify parameters interactively
13			% doInteractive = 0 (default) uses ECCO v4 parameters
14			% and omits budgets and model-data misfits analyses
15	gforget	1.10	%
16	gforget	1.6	%notes : eventually should also use dirMat, dirTex interactively for years=[];
17	gforget	1.1
18			gcmfaces_global; global myparms;
19
20			%%%%%%%%%%%%%%%
21			%pre-processing
22			%%%%%%%%%%%%%%%
23
24	gforget	1.6	if isempty(who('doInteractive')); doInteractive=0; end;
25			myswitch=diags_pre_process(dirModel,dirMat,doInteractive);
26	gforget	1.1
27	gforget	1.9	dirModel=[dirModel '/'];
28			if isempty(dirMat); dirMat=[dirModel 'mat/']; else; dirMat=[dirMat '/']; end;
29
30	gforget	1.10	%%%%%%%%%%%%%%%%%%%%
31			%set loop parameters
32			%%%%%%%%%%%%%%%%%%%%
33
34			years=years-myparms.yearFirst+1;
35			if myparms.diagsAreMonthly;
36			years=years(years<=myparms.recInAve(2)/12);
37			lChunk=12;
38			end;
39			if myparms.diagsAreAnnual;
40			years=years(years<=myparms.recInAve(2));
41			lChunk=1;
42	gforget	1.7	end;
43
44	gforget	1.1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
45			%now do the selected computation chunk:
46			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
47
48			if ~isempty(who('setDiags'));
49	gforget	1.13
50	gforget	1.1	%physical diagnostics
51	gforget	1.6	for myYear=years;
52			diags_select(dirModel,dirMat,setDiags,lChunk,myYear);
53	gforget	1.1	end;
54
55	gforget	1.10	%need profiles, cost, ctrl, budget, 'B' to work in this way too
56	gforget	1.13	%need fix for : ~myswitch.doBudget and setDiags='D' or setDiags{1}='D'
57	gforget	1.10
58	gforget	1.6	else;
59	gforget	1.1
60	gforget	1.6	for myYear=years;
61	gforget	1.10
62	gforget	1.6	%standard physical diagnostics :
63	gforget	1.12	diags_select(dirModel,dirMat,'A',lChunk,myYear);
64	gforget	1.10	if myYear==years(1);
65			recInAve=[myparms.recInAve(1):myparms.recInAve(2)];
66			diags_select(dirModel,dirMat,'B',1,recInAve);
67	gforget	1.7	end;
68	gforget	1.12	diags_select(dirModel,dirMat,'C',lChunk,myYear);
69	gforget	1.10
70			%budgets :
71	gforget	1.1	if myswitch.doBudget;
72	gforget	1.10	for kk=myparms.budgetList;
73	gforget	1.12	diags_select(dirModel,dirMat,{'D',kk},lChunk,myYear);
74	gforget	1.1	end;
75			end;
76	gforget	1.10
77			%model-data misfits :
78	gforget	1.6	% in situ profiles fit
79	gforget	1.9	if myswitch.doProfiles&myYear==years(1); insitu_diags(dirMat,1); end;
80	gforget	1.6	% altimeter fit
81	gforget	1.9	if myswitch.doCost&myYear==years(1); cost_altimeter(dirModel,dirMat); end;
82	gforget	1.6	% other cost terms
83	gforget	1.9	if myswitch.doCost&myYear==years(1); cost_sst(dirModel,dirMat,1); end;
84			if myswitch.doCost&myYear==years(1); cost_bp(dirModel,dirMat,1); end;
85			if myswitch.doCost&myYear==years(1); cost_seaicearea(dirModel,dirMat,1); end;
86	gforget	1.6	% controls
87	gforget	1.9	if myswitch.doCtrl&myYear==years(1); cost_xx(dirModel,dirMat,1); end;
88	gforget	1.10
89	gforget	1.1	end;
90
91			end;
92