rename DatasetTemplate.create() method to to_netcdf()

Author: mhidas

ncwriter/template.py

@@ -421,10 +421,18 @@ def createGlobalAttrs(self):
         for att in self.global_attributes.keys():
             self.ncobj.setncattr(att, self.global_attributes[att])
 
-    def create(self, outfile, mode='w', var_args={}, **kwargs):
-        """Create the file according to all the information in the template"""
+    def to_netcdf(self, outfile, var_args={}, **kwargs):
+        """
+        Create a netCDF file according to all the information in the template.
+        See netCDF4 package documentation for additional arguments.
+
+        :param outfile: Path for the output file (clobbered by default if it already exists!)
+        :param var_args: Additional arguments passed on to  netCDF4.Dataset.createVariables()
+        :param kwargs: Additional arguments for netCDF4.Dataset()
+        :return: None
+        """
         self.outfile = outfile
-        self.ncobj = netCDF4.Dataset(self.outfile, mode=mode, **kwargs)
+        self.ncobj = netCDF4.Dataset(self.outfile, mode='w', **kwargs)
 
         self.update_dimensinos()
         self.createDimensions()

test_ncwriter/test_template.py

@@ -137,16 +137,15 @@ def test_set_variable_values(self):
 
     def test_create_empty_file(self):
         template = DatasetTemplate()
-        template.create(self.temp_nc_file)
+        template.to_netcdf(self.temp_nc_file)
         dataset = Dataset(self.temp_nc_file)
 
     def test_create_file(self):
         template = DatasetTemplate.from_json(TEMPLATE_JSON)
         template.variables['TIME']['values'] = self.values10
         template.variables['DEPTH']['values'] = self.values1
         template.variables['TEMP']['values'] = self.values10.reshape((10, 1))
-        template.create(self.temp_nc_file)
-        print("Created nc file '{}'".format(self.temp_nc_file))
+        template.to_netcdf(self.temp_nc_file)
 
         dataset = Dataset(self.temp_nc_file)