Update perturbIC_test.py

Edit the pytests to improve the commenting

Author: leoberhelman

tests/perturbIC_test.py

@@ -41,17 +41,14 @@ def mock_metadata():
     Outputs
         list - Command line arguements
     """
-    metadata_index_false = Mock()
-    metadata_index_true = Mock()
-    
-    metadata_index_false.lbuser4 = 24
-    metadata_index_true.lbuser4 = -99
-    
+
+    metadata_index_false = 24
+    metadata_index_true = -99
+
     end_of_data = -99
 
     return metadata_index_false,  metadata_index_true, end_of_data
 
-#Test the Imports may not be necessary
 def test_parse_args(monkeypatch, mock_command_line):
     """
     This function tests the parse_args function with the fake commandline arguments
@@ -67,16 +64,7 @@ def test_parse_args(monkeypatch, mock_command_line):
     assert args.amplitude == 0.4
     assert args.seed == 23452
     assert args.output == "restart_dump_copy_perturb.astart"
-#Test checking the seed
-#def test_set_seed(args):
-#Not sure if we need test but the conditionals in a function is nice. 
-
-
-#Test creating output file
-#def test_creating_output_file():
-
 
-#Test the random generator
 def test_create_perturbation(monkeypatch, mock_command_line, mock_perturbation):
     """
     This function tests the create_perturbation function with the fake commandline arguments
@@ -109,7 +97,7 @@ def test_is_end_of_file_keep_going(mock_metadata):
     assert is_end_of_file(metadata_index_true, end_of_data) == True
 
 
-#Test that the perturbation has been applied
+
 def test_applying_perturbation(mock_perturbation):
 
     """
@@ -124,26 +112,30 @@ def test_applying_perturbation(mock_perturbation):
         The results of assertion tests. 
     """
 
-    #Create random perturbation
+    # Create random perturbation
     nlon, nlat = mock_perturbation
     perturbation = 0.5 * (2.*rs.random(nlon*nlat).reshape((nlat,nlon))-1.)
     perturbation[0] = 0
     perturbation[-1] = 0
-    stash_code = 24
+    stash_code = 4
 
-    #Create a fake data array to simulate the numpy array that is 
-    #To mock the method readfld that reads the field corresponding 
-    #To the itemcode 
-                                                                                                                
+    # Create a fake data array to simulate the numpy array that is 
+    # To mock the method readfld that reads the field corresponding to the itemcode 
+    
     shape = (nlat, nlon)
     field_theta = Mock()
     field_not_theta = Mock()
 
-    field_theta.lbuser4 = 24
+    field_theta.lbuser4 = 4
     field_not_theta.lbuser4 = 3
-    #Testing if the perturb conditional works and if the resulting array is correct
+    
+    # Testing if the perturb conditional works and if the resulting array is correct
+    
     #testing_a = np.round((perturbed_array - perturb) / np.ones(shape),0) 
     assert do_perturb(field_theta, stash_code) == True
     assert do_perturb(field_not_theta, stash_code) == False
     #assert perturbed_array.shape == (nlat, nlon)
     #assert testing_a.all() == 1.
+
+                                                                                                                                                                                                                                                            148,0-1       Bot
+