utils/matlab/README.txt

% $Header: /u/gcmpack/MITgcm/utils/matlab/README.txt,v 1.3 2012/10/04 14:02:42 jmc Exp $
% $Name:  $

The following utilities are available in this directory:

  cm_landwater.m            :: creates colormap for plotting bathymetry/orography
  contourfv.m               :: customized contourf version (for finite volume topo)
  densjmd95.m               :: calculate in-situ density (Jackett & McDougall 1995)
  densmdjwf.m               :: calculate in-situ density (McDougall et.al. 2003)
  dens_poly3.m              :: calculate in-situ density as MITgcm POLY3
  gluemnc.m                 :: glue together different tiles into a global file
  grepread.m                :: a new (from Aug 2001) useful script
  griddata_fast.m           :: script to help use cube and netcdf
  griddata_preprocess.m     :: script to help use cube and netcdf
  ini_poly3.m               :: calculate in-situ density as MITgcm POLY3
  inpaint_nans.m            :: used by interpickups.m (for topography mask)
  interpickups.m            :: interpolate mnc pickup files
  ioLb2num.m                :: convert from ptracer io-label to ptracer number
  load_grid.m               :: load MITgcm output grid-files into one structure array
  longitude.m               :: new (from Aug 2001) script for plotting cube stuff.
  mnc_assembly.m            :: assemble MNC tiles into single NetCDF files
  nc_add.m                  :: script to help use cube and netcdf
  num2ioLb.m                :: convert from ptracer number to ptracer io-label
  pcolorfv.m                :: customized pcolor version (for finite volume topo)
  rdmds.m                   :: read MDSIO output (data & meta) files
  rdmeta.m                  :: read MDSIO output meta file
  rdmnc.m                   :: read tiled MNC output files
  stats.m                   :: calculate and print basic statistics of 1 array
  test_nc_add.m             :: script to help use cube and netcdf


Subdirectories:

  Graphix                   :: cubed-sphere data manipulation and plotting package
  cs_grid                   :: cubed-sphere and lat-lon-cap routines
  gmt                       :: general MITgcm tiles/topologies
  ocean_basin               :: basin mask generation routines


And more complete directions for each script are:

===  mnc_assembly.m  ===

  This utility is available for assembling the data from one or more
  variables contained in multiple MNC tiles (each having their own
  file) into a single NetCDF file.  It understands both "old-style"
  MITgcm exch1 topologies and newer exch2 topologies.  A complete set
  of examples demonstrating the use of this tool on both exch1 and
  exch2 data sets is available from the MITgcm.org CVS server at:

    $ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
    $ cvs login
    $ cvs co development/edhill/mnc_assembly
1	dimitri	1.4	% $Header: /u/gcmpack/MITgcm/utils/matlab/README.txt,v 1.3 2012/10/04 14:02:42 jmc Exp $
2	jmc	1.2	% $Name: $
3	edhill	1.1
4			The following utilities are available in this directory:
5
6	jmc	1.2	cm_landwater.m :: creates colormap for plotting bathymetry/orography
7			contourfv.m :: customized contourf version (for finite volume topo)
8			densjmd95.m :: calculate in-situ density (Jackett & McDougall 1995)
9			densmdjwf.m :: calculate in-situ density (McDougall et.al. 2003)
10			dens_poly3.m :: calculate in-situ density as MITgcm POLY3
11			gluemnc.m :: glue together different tiles into a global file
12			grepread.m :: a new (from Aug 2001) useful script
13			griddata_fast.m :: script to help use cube and netcdf
14			griddata_preprocess.m :: script to help use cube and netcdf
15			ini_poly3.m :: calculate in-situ density as MITgcm POLY3
16			inpaint_nans.m :: used by interpickups.m (for topography mask)
17			interpickups.m :: interpolate mnc pickup files
18			ioLb2num.m :: convert from ptracer io-label to ptracer number
19	jmc	1.3	load_grid.m :: load MITgcm output grid-files into one structure array
20	jmc	1.2	longitude.m :: new (from Aug 2001) script for plotting cube stuff.
21	edhill	1.1	mnc_assembly.m :: assemble MNC tiles into single NetCDF files
22	jmc	1.2	nc_add.m :: script to help use cube and netcdf
23			num2ioLb.m :: convert from ptracer number to ptracer io-label
24			pcolorfv.m :: customized pcolor version (for finite volume topo)
25			rdmds.m :: read MDSIO output (data & meta) files
26			rdmeta.m :: read MDSIO output meta file
27			rdmnc.m :: read tiled MNC output files
28			stats.m :: calculate and print basic statistics of 1 array
29			test_nc_add.m :: script to help use cube and netcdf
30	edhill	1.1
31
32	dimitri	1.4	Subdirectories:
33
34			Graphix :: cubed-sphere data manipulation and plotting package
35			cs_grid :: cubed-sphere and lat-lon-cap routines
36			gmt :: general MITgcm tiles/topologies
37			ocean_basin :: basin mask generation routines
38
39
40	edhill	1.1	And more complete directions for each script are:
41
42			=== mnc_assembly.m ===
43
44			This utility is available for assembling the data from one or more
45			variables contained in multiple MNC tiles (each having their own
46			file) into a single NetCDF file. It understands both "old-style"
47			MITgcm exch1 topologies and newer exch2 topologies. A complete set
48			of examples demonstrating the use of this tool on both exch1 and
49			exch2 data sets is available from the MITgcm.org CVS server at:
50
51			$ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
52			$ cvs login
53			$ cvs co development/edhill/mnc_assembly