<p><b>dwj07@fsu.edu</b> 2011-01-28 07:58:26 -0700 (Fri, 28 Jan 2011)</p><p><br>
        BRANCH COMMIT:<br>
        Adding comments with instructions to basin.F, as well as a descriptive README file.<br>
</p><hr noshade><pre><font color="gray">Added: branches/ocean_projects/basin/README
===================================================================
--- branches/ocean_projects/basin/README                                (rev 0)
+++ branches/ocean_projects/basin/README        2011-01-28 14:58:26 UTC (rev 708)
@@ -0,0 +1,18 @@
+Program: basin
+
+This program reads in a MPAS grid file (grid.nc) and outputs a modified grid file 
+(ocean.nc) and it's associated graph.info files for partitions from 2 up to 1024 in powers of 2.
+
+The purpose of this code is to remove grid cells from any valid MPAS grid. 
+Please see source file src/basin.F to define the specifics of the output grid file.
+
+After a grid.nc file has been placed in this directory, simply run the script runit.
+
+This script will compile basin, run basin (producing an ocean.nc file) and use metis
+to partition the graph.info file.
+
+The metis portion of the script requires the executable kmetis to be in your path. 
+If it is not, none of the graph.info.part.N files will be created, but can later be
+created manually using metis and the assocaite graph.info file.
+
+

Modified: branches/ocean_projects/basin/src/basin.F
===================================================================
--- branches/ocean_projects/basin/src/basin.F        2011-01-26 20:12:39 UTC (rev 707)
+++ branches/ocean_projects/basin/src/basin.F        2011-01-28 14:58:26 UTC (rev 708)
@@ -6,13 +6,22 @@
 use utilities
 
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+! Program: basin.F
 !
 ! This program is meant to add land to grids, as well as initial conditions.
 ! 
-! It needs to be modified for specific cases, to find the modification areas,
-! one can search for the flag
-!   basin-mod
+! This program is used to take a specific mesh, and remove Cells from it
+! It can be used to change a planar grid into a Channel or a basin grid, or to 
+! Change a spherical grid into a Limited area spherical grid.
 !
+! How to use:
+! Step 1: Set the number of Vertical levels, and Tracers
+! Step 2: Set if the grid is on a sphere or not, and it's radius
+! Step 3: Specify some Parameters
+! Step 4: Check the Initial conditions routine get_init_conditions
+! Step 5: Check the depth routine define_kmt
+!
+!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 implicit none
 
@@ -41,6 +50,7 @@
 
 real, dimension(25) :: dz
 
+! Step 1: Set the number of Vertical levels, and Tracers
 integer, parameter :: nVertLevelsMOD = 1
 integer, parameter :: nTracersMod = 2
 
@@ -55,6 +65,7 @@
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 
+! Step 2: Set if the grid is on a sphere or not, and it's radius
 character (len=16) :: on_a_sphere = 'YES              '
 real*8, parameter :: sphere_radius = 6.37122e6
 
@@ -63,6 +74,7 @@
 
 logical, parameter :: real_bathymetry=.false.
 
+! Step 3: Specify some Parameters
    real (kind=8), parameter :: &amp;
     h_total_max = 2000.0, &amp;
     u_max = 0.0, &amp;
@@ -235,6 +247,7 @@
 end subroutine write_graph
 
 
+!Step 4: Check the Initial conditions routine get_init_conditions
 subroutine get_init_conditions
 implicit none
 real :: halfwidth, dtr, pi, p(3), q(3), xin, yin, zin, ulon, ulat, stress, n1, n2, distance, r 
@@ -974,7 +987,7 @@
 
 end subroutine write_grid
 
-
+! Step 5: Check the depth routine define_kmt
 subroutine define_kmt
 implicit none
 real (kind=4), allocatable, dimension(:) :: x,y, work_kmt

</font>
</pre>