[Dart-dev] DART/branches Revision: 11926

[dart at ucar.edu]

thoar at ucar.edu
2017-08-30 16:48:37 -0600 (Wed, 30 Aug 2017)
230
Moving a support routine to the private directory.
Changing the DART.m documentation to reflect the new
DART layout - there are fewer directories.

Adding an enhancement comment to two_experiments_profile.m so
I don't forget it.




Deleted: DART/branches/rma_trunk/diagnostics/matlab/locations_in_region.m
===================================================================
--- DART/branches/rma_trunk/diagnostics/matlab/locations_in_region.m	2017-08-30 22:43:39 UTC (rev 11925)
+++ DART/branches/rma_trunk/diagnostics/matlab/locations_in_region.m	2017-08-30 22:48:37 UTC (rev 11926)
@@ -1,68 +0,0 @@
-function inds = locations_in_region(locations, region)
-%% locations_in_region returns the indices of the locations in the specified region.
-%
-% USAGE:
-% inds = locations_in_region(locations, region);
-%
-% locations is N-by-3 array of locations - [lon; lat; lvl]
-% region is an N-by-1 array of region boundaries:
-%        [leftlon rightlon minlat maxlat [minz maxz]]
-%        If leftlon is numerically larger than rightlon,
-%        the region will span the Prime Meridian.
-%
-% EXAMPLE: simple case
-% inds = locations_in_region(locations,[180 360 -90 90]); % Western Hemisphere
-%
-% EXAMPLE: longitude region spanning the Prime Meridian
-% inds = locations_in_region(locations,[330 180 -90 90]); % Everything BUT the Americas
-%
-% EXAMPLE: vertical subsetting
-% inds = locations_in_region(locations,[0 360 -90 90 0 1000]); % Everything  between 0,1000
-
-%% DART software - Copyright UCAR. This open source software is provided
-% by UCAR, "as is", without charge, subject to all terms of use at
-% http://www.image.ucar.edu/DAReS/DART/DART_download
-%
-% DART $Id$
-
-if (length(region) == 6)
-   zmin = min(region(5:6));
-   zmax = max(region(5:6));
-elseif (length(region) < 4)
-   error('region must be an array of length 4 or 6')
-end
-
-ymin = min(region(3:4));
-ymax = max(region(3:4));
-xmin = mod(region(1),360.0);
-xmax = mod(region(2),360.0);
-
-lons = mod(locations(:,1),360.0);
-
-% find the ones in the right latitudes & levels
-
-latlogical = ((locations(:,2) >= ymin) & (locations(:,2) <= ymax));
-lvllogical = ((locations(:,3) >= zmin) & (locations(:,3) <= zmax));
-
-% find the ones in the right longitudes ... including wrapping
-
-if ( xmin == xmax )
-   lonlogical = ones(size(latlogical));   % everybody plays
-else
-
-   if ( xmin > xmax )
-      xmax = xmax + 360.0;
-      inds = find(lons < xmin);
-      lons(inds) = lons(inds) + 360.0;
-   end
-   lonlogical = ((lons >= xmin) & (lons <= xmax));
-end
-
-% put it all together ...
-
-inds = find( (lonlogical .* latlogical .* lvllogical) > 0 );
-
-% <next few lines under version control, do not edit>
-% $URL$
-% $Revision$
-% $Date$

Modified: DART/branches/rma_trunk/diagnostics/matlab/private/DART.m
===================================================================
--- DART/branches/rma_trunk/diagnostics/matlab/private/DART.m	2017-08-30 22:43:39 UTC (rev 11925)
+++ DART/branches/rma_trunk/diagnostics/matlab/private/DART.m	2017-08-30 22:48:37 UTC (rev 11926)
@@ -1,53 +1,51 @@
-%% 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 - 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
+%% These functions explore the DART state-space diagnostic files -- the output of the _stages_to_write_ netCDF files.
+% 
+% * plot_bins.m rank histograms
+% * plot_correl.m		space-time series of correlation