Amended method names to snake case

Author: ANDREWNGT

kessler/cdm.py

@@ -14,7 +14,6 @@
 import datetime
 import copy
 import pandas as pd
-from . import time_utils
 from . import util
 
 
@@ -196,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.getCcsdsTimeFormat(value)
+                timeFormat = util.get_ccsds_time_format(value)
                 idx = timeFormat.find('DDD')
                 if idx!=-1:
-                    value = util.DOY2Date(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

@@ -349,10 +349,11 @@ def progress_bar_end(message=None):
     if message is not None:
         print(message)
 
-def getCcsdsTimeFormat(time_string):
+def get_ccsds_time_format(time_string):
     '''
     Adapted by Andrew Ng, 18/3/2022.
     Original MATLAB source code found at: https://github.com/nasa/CARA_Analysis_Tools/blob/master/two-dimension_Pc/Main/TransformationCode/TimeTransformations/getCcsdsTimeFormat.m
+    get_ccsds_time_format  -  process and outputs the format of the time string extracted from the CDM. 
     The CCSDS time format is required to be of the general form
     yyyy-[mm-dd|ddd]THH:MM:SS[.F*][Z]
     (1) The date and time fields are separated by a "T".
@@ -366,9 +367,12 @@ def getCcsdsTimeFormat(time_string):
     (6) If a fraction of seconds is provided, it is separated from the two
         digit seconds by a period.
     (7) The time string can end with an optional "Z" time zone indicator
-    
+
     Args:
-        - time)
+        - time_string(``str``): Original time string stored in CDM.
+    Returns: 
+        - time_format(``str``): Outputs the format of the time string. It must be of the form yyyy-[mm-dd|ddd]THH:MM:SS[.F*][Z], otherwise it is invalid and a RuntimeError is raised.
+
     '''
     time_format = []
     numT = time_string.count('T')
@@ -410,12 +414,12 @@ def getCcsdsTimeFormat(time_string):
     time_format = time_format + frac_str
     return time_format
 
-def DOY2Date(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. 
-    DOY2DATE  - 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"

tests/test_util.py

@@ -112,17 +112,17 @@ def test_from_cartesian_to_rtn_2(self):
         self.assertAlmostEqual(np.linalg.norm(state_xyz[0]), np.linalg.norm(state_rtn[0]), places=1)
         self.assertAlmostEqual(np.linalg.norm(state_xyz[1]), np.linalg.norm(state_rtn[1]), places=1)
 
-    def test_getCcsdsTimeFormat(self):
+    def test_get_ccsds_time_format(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.
         test_case1 = "2000-01-01T00:00:00.000" #From AlfanoTestCase11.cdm
         test_case2 = "2018-229T13:56:33.000" # From DensityDecorrelationTestCaseCDM.txt
         test_case1_correct = "yyyy-mm-ddTHH:MM:SS.FFF"
         test_case2_correct = "yyyy-DDDTHH:MM:SS.FFF"
 
-        self.assertEqual(kessler.util.getCcsdsTimeFormat(test_case1), test_case1_correct)
-        self.assertEqual(kessler.util.getCcsdsTimeFormat(test_case2), test_case2_correct) 
-    def test_DOY2Date(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):
         # 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_DOY2Date(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.DOY2Date(example1, DOY_1, Year_1, 5), test_case1_correct)
-        self.assertEqual(kessler.util.DOY2Date(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)