Fixed names

Author: ANDREWNGT

kessler/cdm.py

@@ -195,10 +195,10 @@ def set_header(self, key, value):
         if key in self._keys_header:
             if key in self._keys_with_dates:
                 # We have a field with a date string as the value. Check if the string is in the format needed by the CCSDS 508.0-B-1 standard
-                timeFormat = util.get_ccsds_time_format(value)
-                idx = timeFormat.find('DDD')
+                time_format = util.get_ccsds_time_format(value)
+                idx = time_format.find('DDD')
                 if idx!=-1:
-                    value = util.DOY_2_date(value, value[idx:idx+3], value[0:4], idx)
+                    value = util.doy_2_date(value, value[idx:idx+3], value[0:4], idx)
                 try:
                     _ = datetime.datetime.strptime(value, '%Y-%m-%dT%H:%M:%S.%f')
                 except Exception as e:

kessler/util.py

@@ -390,9 +390,9 @@ def get_ccsds_time_format(time_string):
         raise RuntimeError(f"*** Error -- Invalid CCSDS time string: {time_string} \nDate format not one of yyyy-mm-dd or yyyy-DDD.\n")
     # % Check if 'Z' time zone indicator appended to the string
     if time_string[-1]=='Z':
-        zOpt = True
+        z_opt = True
     else:
-        zOpt = False
+        z_opt = False
     # % Find location of the fraction of seconds decimal separator
     num_decimal = time_string.count('.')
     if num_decimal > 1:
@@ -401,37 +401,37 @@ def get_ccsds_time_format(time_string):
     idx_decimal = time_string.find('.')
     nfrac = 0
     if num_decimal != 0:
-        if zOpt:
+        if z_opt:
             nfrac = len(time_string) - 1 - idx_decimal -1
         else: 
             nfrac = len(time_string) - 1 - idx_decimal
     if nfrac > 0:
         frac_str = '.' + ('F'*nfrac)
     else:
         frac_str = ""
-    if zOpt:
+    if z_opt:
         frac_str = frac_str+'Z'
     time_format = time_format + frac_str
     return time_format
 
-def DOY_2_date(value, DOY, YEAR, idx):
+def doy_2_date(value, doy, year, idx):
     '''
     Written by Andrew Ng, 18/03/2022, 
     Based on source code @ https://github.com/nasa/CARA_Analysis_Tools/blob/master/two-dimension_Pc/Main/TransformationCode/TimeTransformations/DOY2Date.m
     Use the datetime python package. 
-    DOY_2_date  - Converts Day of Year (DOY) date format to date format.
+    doy_2_date  - Converts Day of Year (DOY) date format to date format.
     
     Args:
         - value(``str``): Original date time string with day of year format "YYYY-DDDTHH:MM:SS.ff"
-        - DOY  (``str``): The day of year in the DOY format. 
-        - YEAR (``str``): The year.
+        - doy  (``str``): The day of year in the DOY format. 
+        - year (``str``): The year.
         - idx  (``int``): Index of the start of the original "value" string at which characters 'DDD' are found. 
     Returns: 
         -value (``str``): Transformed date in traditional date format. i.e.: "YYYY-mm-ddTHH:MM:SS.ff"
 
     '''
     # Calculate datetime format
-    date_num = datetime.datetime(int(YEAR), 1, 1) + datetime.timedelta(int(DOY) - 1)
+    date_num = datetime.datetime(int(year), 1, 1) + datetime.timedelta(int(doy) - 1)
     # Split datetime object into a date list
     date_vec = [date_num.year, date_num.month, date_num.day, date_num.hour, date_num.minute]
     value = str(date_vec[0]) +'-' + str(date_vec[1]) + '-' + str(date_vec[2]) + 'T' + value[idx+4:-1] 

tests/test_util.py

@@ -122,7 +122,7 @@ def test_get_ccsds_time_format(self):
 
         self.assertEqual(kessler.util.get_ccsds_time_format(test_case1), test_case1_correct)
         self.assertEqual(kessler.util.get_ccsds_time_format(test_case2), test_case2_correct) 
-    def test_DOY_2_date(self):
+    def test_doy_2_date(self):
         # This test is written by Andrew Ng, 19/03/22. It makes use of example CDMs provided by the NASA CARA
         # analysis repo at https://github.com/nasa/CARA_Analysis_Tools/tree/master/two-dimension_Pc/UnitTest/InputFiles.
         example1 = "2010-202T12:25:19.000" # From SingleCovTestCase1-4.cdm
@@ -133,6 +133,6 @@ def test_DOY_2_date(self):
         Year_2= example2[0:4]
         test_case1_correct = "2010-7-21T12:25:19.00"
         test_case2_correct = "2018-8-17T13:56:33.00"
-        self.assertEqual(kessler.util.DOY_2_date(example1, DOY_1, Year_1, 5), test_case1_correct)
-        self.assertEqual(kessler.util.DOY_2_date(example2, DOY_2, Year_2, 5), test_case2_correct) 
+        self.assertEqual(kessler.util.doy_2_date(example1, DOY_1, Year_1, 5), test_case1_correct)
+        self.assertEqual(kessler.util.doy_2_date(example2, DOY_2, Year_2, 5), test_case2_correct)