Matlab Processing Scripts: Difference between revisions
Created page with "<div class="title">Matlab Processing Script for Nesting</div> __TOC__" (change visibility) |
No edit summary (change visibility) |
||
| Line 1: | Line 1: | ||
<div class="title">Matlab Processing | <div class="title">Matlab Processing Scripts for Nesting</div> __TOC__ | ||
The Matlab processing scripts for nesting applications are divided in four categories: | |||
* Scripts to aid in the building of nested grids and associated NetCDF files, | |||
* Scripts to process contact regions and contact points and build its associated NetCDF file, | |||
* Scripts to process initial conditions data and NetCDF files, and | |||
* Generic support scripts. | |||
{{note}} '''Notice:''' Starting Matlab version '''2012a''', released on Feb 9, 2012, the '''native''' interface to NetCDF is the preferred method for processing NetCDF data in the scripts distributed in the ROMS repository '''matlab''': <span class="red"><nowiki>https://www.myroms.org/svn/src/matlab</nowiki></span>. The '''native''' interface was introduced in Matlab version '''2008b''' for NetCDF-3 type files. The NetCDF-4 support started in version '''2010b'''. The support for HDF5 files was completed in version '''2011a'''. The OpenDAP support began in version '''2012a'''. If your Matlab version is older than 2008b, we highly recommend to update to the newest version. However, in the basic generic scripts we have switches for older versions to activate either the '''MEXNC''' interface for standard NetCDF files and the '''SNCTOOLS''' interface to process NetCDF files on an OpenDAP server. | |||
==Nested Grid Generation Scripts== | |||
Currently, it is not our intention to develop a fancy GUI tool to prepare ROMS nested grids. The capability of ROMS nesting is unique and requires special tools since we support mosaics, composite, and refinement grids in a variety of [[Nested_Grids#Nested_Grids_Classes|nested classes]]. Perhaps in the future an expert user will help us develop this GUI. However, the scripts described here are basic and fundamental. They can be used in the future to build a fancier interface. | |||
;<span id="c_grid"></span><span class="blue">c_grid.m</span> | |||
:Creates a new ROMS grid NetCDF file or modifies a existing ROMS grid NetCDF file.<br /> | |||
:<span class="green">status</span> = <span class="red">c_grid</span>(<span class="green">Lp</span>,<span class="green">Mp</span>, <span class="green">Gname</span>, <span class="green">NewFile</span>, <span class="green">spherical</span>) | |||
:'''On Input:''' | |||
:<span class="green">Lp</span>: Number of ρ-point in the ξ-direction | |||
:<span class="green">Mp</span>: Number of ρ-point in the η-direction | |||
:<span class="green">Gname</span>: Grid NetCDF file name (string) | |||
:<span class="green">NewFile</span>: Switch to create a new file (logical, optional, default false) | |||
:<span class="green">spherical</span>: Spherical grid switch (logical, optional, default true) | |||
:'''On Ouput:''' | |||
:<span class="green">status</span>: Error flag | |||
==Contact Regions and Contact Points Scripts== | |||
==Initial Condition Scripts== | |||
==Support Scripts== | |||
Revision as of 20:27, 20 April 2012
The Matlab processing scripts for nesting applications are divided in four categories:
- Scripts to aid in the building of nested grids and associated NetCDF files,
- Scripts to process contact regions and contact points and build its associated NetCDF file,
- Scripts to process initial conditions data and NetCDF files, and
- Generic support scripts.
Notice: Starting Matlab version 2012a, released on Feb 9, 2012, the native interface to NetCDF is the preferred method for processing NetCDF data in the scripts distributed in the ROMS repository matlab: https://www.myroms.org/svn/src/matlab. The native interface was introduced in Matlab version 2008b for NetCDF-3 type files. The NetCDF-4 support started in version 2010b. The support for HDF5 files was completed in version 2011a. The OpenDAP support began in version 2012a. If your Matlab version is older than 2008b, we highly recommend to update to the newest version. However, in the basic generic scripts we have switches for older versions to activate either the MEXNC interface for standard NetCDF files and the SNCTOOLS interface to process NetCDF files on an OpenDAP server.
Nested Grid Generation Scripts
Currently, it is not our intention to develop a fancy GUI tool to prepare ROMS nested grids. The capability of ROMS nesting is unique and requires special tools since we support mosaics, composite, and refinement grids in a variety of nested classes. Perhaps in the future an expert user will help us develop this GUI. However, the scripts described here are basic and fundamental. They can be used in the future to build a fancier interface.
- c_grid.m
- Creates a new ROMS grid NetCDF file or modifies a existing ROMS grid NetCDF file.
- status = c_grid(Lp,Mp, Gname, NewFile, spherical)
- On Input:
- Lp: Number of ρ-point in the ξ-direction
- Mp: Number of ρ-point in the η-direction
- Gname: Grid NetCDF file name (string)
- NewFile: Switch to create a new file (logical, optional, default false)
- spherical: Spherical grid switch (logical, optional, default true)
- On Ouput:
- status: Error flag
