Changeset 6058

Timestamp:

Dec 11, 2008, 1:14:46 PM (15 years ago)

Author:

rwilson

Message:

Removed old 'run from commandline' code, added comments, pep8'd it.

File:

• anuga_core/source/anuga/shallow_water/most2nc.py (modified) (7 diffs)

anuga_core/source/anuga/shallow_water/most2nc.py

@@ -1 +1 @@
 """This has to do with creating elevation data files for use with ferret2sww.
-It reads a bathymetry ascii file and creates a NetCDF (nc) file similar to MOSTs output.
+It reads a bathymetry ascii file and creates a NetCDF (nc) file similar to
+MOSTs output.
 
  $Author: Peter Row
@@ -6 +7 @@
 """
 
+import sys
+from Scientific.IO.NetCDF import NetCDFFile
 
-def most2nc(input_file=None,output_file=None,inverted_bathymetry = False,\
-            verbose = True):
-    #input_file = 'small.txt'
-    #output_file = 'small_e.nc'
 
+##
+# @brief Convert a MOST file to NetCDF format.
+# @param input_file The input file to convert.
+# @param output_file The name of the oputput NetCDF file to create,
+# @param inverted_bathymetry ??
+# @param verbose True if the function is to be verbose.
+def most2nc(input_file, output_file, inverted_bathymetry=False, verbose=True):
+    # variable names
     long_name = 'LON'
     lat_name = 'LAT'
+    elev_name = 'ELEVATION'
+
+    # set up bathymetry
     if inverted_bathymetry:
         up = -1.
@@ -19 +29 @@
         up = +1.
 
-    from Scientific.IO.NetCDF import NetCDFFile
-    import sys
+    # read data from the MOST file
+    in_file = open(input_file,'r')
 
-    try:
-        if input_file is None:
-            input_file = sys.argv[1]
-        if output_file is None:
-            output_file = sys.argv[2]
-    except:
-        raise 'usage is: most2nc input output'
+    if verbose: print 'reading header'
 
-    in_file = open(input_file,'r')
-    if verbose: print 'reading header'
     nx_ny_str = in_file.readline()
     nx_str,ny_str = nx_ny_str.split()
@@ -60 +62 @@
             #j = k/nx
             out_depth_list[(k-1)/nx].append(float(string)*up)
-            #print k,len(out_depth_list),(k-1)/nx,out_depth_list[(k-1)/nx][-1],len(out_depth_list[(k-1)/nx])
             if k==nx*ny:
                 break
@@ -71 +72 @@
     depth_list = out_depth_list
 
+    # write the NetCDF file
     if verbose: print 'writing results'
 
@@ -76 +78 @@
 
     out_file.createDimension(long_name,nx)
+
     out_file.createVariable(long_name,'d',(long_name,))
     out_file.variables[long_name].point_spacing='uneven'
@@ -87 +90 @@
     out_file.variables[lat_name].assignValue(h2_list)
 
-    out_file.createVariable('ELEVATION','d',(lat_name,long_name))
-    out_file.variables['ELEVATION'].point_spacing='uneven'
-    out_file.variables['ELEVATION'].units='meters'
-    out_file.variables['ELEVATION'].assignValue(depth_list)
+    out_file.createVariable(elev_name,'d',(lat_name,long_name))
+    out_file.variables[elev_name].point_spacing='uneven'
+    out_file.variables[elev_name].units='meters'
+    out_file.variables[elev_name].assignValue(depth_list)
 
     out_file.close()