[Dart-dev] [4143] DART/trunk/matlab: If someone does a "help DART" from a DART-enabled matlab session,

[nancy at ucar.edu]

Revision: 4143
Author:   thoar
Date:     2009-11-06 15:24:18 -0700 (Fri, 06 Nov 2009)
Log Message:
-----------
If someone does a "help DART" from a DART-enabled matlab session,
they will now get a screenful of the DART functions.
The startup.m has been modified to try to automatically add support
for the observations/utilities functions that use the netCDF version
of the observation sequences.

Modified Paths:
--------------
    DART/trunk/matlab/startup.m

Added Paths:
-----------
    DART/trunk/matlab/DART.m

-------------- next part --------------
Added: DART/trunk/matlab/DART.m
===================================================================
--- DART/trunk/matlab/DART.m	                        (rev 0)
+++ DART/trunk/matlab/DART.m	2009-11-06 22:24:18 UTC (rev 4143)
@@ -0,0 +1,50 @@
+% DART - the list of routines useful for exploring the output of the DART 
+%        ensemble assimilation software. This is not intended to be an exhaustive
+%        list, but it should get you started. -- Tim
+% 
+% 
+% DART/matlab			These functions explore the [Truth,] Prior,Posterior netCDF
+%                               files. Useful for "state-space" diagnostics.
+% plot_bins.m                   rank histograms 
+% plot_correl.m			space-time series of correlation
+% plot_ens_err_spread.m		summary plots of the ensemble error and ensemble spread
+% plot_ens_mean_time_series.m	time series of ensemble mean and truth
+% plot_ens_time_series.m	time series of ensemble members, mean and truth
+% plot_phase_space.m		trajectory of 3 state variables of a single ensemble member
+% plot_sawtooth.m		time series of a state variable including updates
+% plot_smoother_err.m		global error and spread using the smoother
+% plot_total_err.m		plots of global error and spread of ensemble mean
+% plot_var_var_correl.m		correlation of a vrbl at a time and another vrbl at all times
+% 
+% 
+% DART/diagnostics/matlab	This block requires that the observation sequences in
+%                               question have been run through "obs_diag" and have
+%                               resulted in "obs_diag_output.nc" files. Strictly
+%                               "observation-space" diagnostics. Typical quantities of
+%                               interest are : rmse, bias, spread, totalspread, ...
+% plot_observation_locations.m	locations of observations, by QC value 
+% plot_profile.m		vertical profile of a single quantity
+% plot_bias_xxx_profile.m	vertical profile of the bias and any other quantity
+% plot_rmse_xxx_profile.m 	vertical profile of the rmse and any other quantity
+% plot_evolution.m		temporal evolution of any quantity
+% plot_rmse_xxx_evolution.m	temporal evolution of the rmse and one other quantity
+% plot_wind_vectors.m		This is a "one-off" ... since DART actually only knows 
+%                               about univariate observations, matching them into pairs 
+%                               is perilous ...
+% 
+% 
+% DART/observations/utilities/threed_sphere	These functions require processing 
+%                               observation sequences into netCDF files with 
+%                               "obs_seq_to_netcdf" - which currently does not preserve
+%                               all of the observation sequence metadata for some of the
+%                               more complicated observation types. 
+% read_obs_netcdf.m		Reads a netCDF observation sequence and returns a structure.
+% plot_obs_netcdf.m		creates a 2D or 3D plot of the observation locations 
+%                               and values - and rejected observations.
+% plot_obs_netcdf_diffs.m	Same thing, only for the difference of two observation copies
+%                               - the observation and the ensemble mean, for example.
+% 
+% 
+% DART/models/<modelname>/matlab	Each model has an optional matlab directory where
+%                               the model developers are free to supply whatever functions
+%                               or scripts they deem useful.


Property changes on: DART/trunk/matlab/DART.m
___________________________________________________________________
Added: svn:mime-type
   + text/x-matlab
Added: svn:keywords
   + Date Rev Author URL Id
Added: svn:eol-style
   + native

Modified: DART/trunk/matlab/startup.m
===================================================================
--- DART/trunk/matlab/startup.m	2009-11-06 21:20:32 UTC (rev 4142)
+++ DART/trunk/matlab/startup.m	2009-11-06 22:24:18 UTC (rev 4143)
@@ -40,7 +40,7 @@
 disp(sprintf('\nWelcome to DART ...'))
 disp(sprintf('\nYour current directory is  %s',mydir))
 
-if ( ~isempty(dartloc) ) 
+if ( ~isempty(dartloc) )
    path(dartpath,path);
    disp(sprintf('Using general tools in     %s',dartpath))
 end
@@ -49,11 +49,20 @@
 
 dartpath = sprintf('%s/diagnostics/matlab',mydir(1:dartloc));
 
-if ( ~isempty(dartloc) ) 
+if ( ~isempty(dartloc) )
    path(dartpath,path);
    disp(sprintf('observation-space tools in %s',dartpath))
 end
 
+% Try to intelligently add the observation-space netCDF DART tools.
+
+dartpath = sprintf('%s/observations/utilities/threed_sphere',mydir(1:dartloc));
+
+if ( ~isempty(dartloc) )
+   path(dartpath,path);
+   disp(sprintf('obs-seq netCDF tools in    %s',dartpath))
+end
+
 % Try to intelligently add the DART model-specific tools.
 % If the cwd is a '<model>/work' directory, check to see if there is a 
 % parallel '<model>/matlab' directory.
@@ -62,10 +71,10 @@
 dartloc  = strfind(mydir,'/work')-1;
 dartpath = sprintf('%s/matlab',mydir(1:dartloc));
 
-if ( ~isempty(dartloc) ) 
+if ( ~isempty(dartloc) )
    if ( exist(dartpath,'dir') == 7 )
       path(dartpath,path);
-      disp(sprintf('Using matlab scripts in     %s',dartpath))
+      disp(sprintf('Using matlab scripts in    %s',dartpath))
    end
 end