geospacelab 0.11.4__py3-none-any.whl → 0.12.0__py3-none-any.whl

geospacelab/datahub/sources/tud/champ/wnd_acc/__init__.py

@@ -25,7 +25,7 @@ default_dataset_attrs = {
     'instrument': 'ACC',
     'product': 'WND-ACC',
     'data_file_ext': 'txt',
-    'product_version': 'v01',
+    'product_version': 'v02',
     'data_root_dir': prf.datahub_data_root_dir / 'TUD' / 'CHAMP',
     'allow_load': True,
     'allow_download': True,
@@ -38,19 +38,38 @@ default_dataset_attrs = {
     'time_clip': True,
 }
 
-default_variable_names_v01 = [    
+default_variable_names_v01 = [
     'SC_DATETIME',
     'SC_GEO_LAT',
     'SC_GEO_LON',
     'SC_GEO_ALT',
     'SC_ARG_LAT',
     'SC_GEO_LST',
+    'u_CROSS',
+    'UNIT_VECTOR_N',
+    'UNIT_VECTOR_E',
+    'UNIT_VECTOR_D',
     'u_CROSS_N',
     'u_CROSS_E',
-    'u_CROSS_U',
+    'u_CROSS_D',
+]
+default_variable_names_v02 = [
+    'SC_DATETIME',
+    'SC_GEO_LAT',
+    'SC_GEO_LON',
+    'SC_GEO_ALT',
+    'SC_ARG_LAT',
+    'SC_GEO_LST',
     'u_CROSS',
+    'UNIT_VECTOR_N',
+    'UNIT_VECTOR_E',
+    'UNIT_VECTOR_D',
+    'u_CROSS_N',
+    'u_CROSS_E',
+    'u_CROSS_D',
+    'FLAG',
     ]
-default_variable_names_v02 = []
+
 
 # default_data_search_recursive = True
 
@@ -67,10 +86,12 @@ class Dataset(datahub.DatasetSourced):
         self.facility = kwargs.pop('facility', 'CHAMP')
         self.instrument = kwargs.pop('instrument', 'ACC')
         self.product = kwargs.pop('product', 'WND-ACC')
-        self.product_version = kwargs.pop('product_version', 'v01')
+        self.product_version = kwargs.pop('product_version', 'v02')
         self.local_latest_version = ''
         self.allow_download = kwargs.pop('allow_download', False)
         self.force_download = kwargs.pop('force_download', False)
+        self.download_dry_run = kwargs.pop('download_dry_run', False)
+        
         self.add_AACGM = kwargs.pop('add_AACGM', False) 
         self.add_APEX = kwargs.pop('add_APEX', False)
         self._data_root_dir = self.data_root_dir    # Record the initial root dir
@@ -130,7 +151,41 @@ class Dataset(datahub.DatasetSourced):
 
         if self.add_APEX:
             self.convert_to_APEX()
-            
+        self._add_u_CT()
+
+    def _add_u_CT(self):
+        from geospacelab.observatory.orbit.utilities import LEOToolbox
+        ds_leo = LEOToolbox(self.dt_fr, self.dt_to)
+        ds_leo.clone_variables(self)
+
+        wind_unit_vector = np.concatenate(
+            (
+                self['UNIT_VECTOR_N'].value,
+                self['UNIT_VECTOR_E'].value,
+                self['UNIT_VECTOR_D'].value
+            ),
+            axis=1
+        )
+        orbit_unit_vector = ds_leo.trajectory_local_unit_vector()
+        cp = np.cross(orbit_unit_vector, wind_unit_vector)
+        u_CT = -np.sign(cp[:, 2]) * (
+                (self['u_CROSS'].value.flatten() * self['UNIT_VECTOR_N'].flatten()) ** 2 +
+                (self['u_CROSS'].value.flatten() * self['UNIT_VECTOR_E'].flatten()) ** 2) ** 0.5
+        u_VCT = self['u_CROSS'].value.flatten() * self['UNIT_VECTOR_D'].flatten()
+
+        var = self['u_CROSS'].clone()
+        var.name = 'u_CT'
+        var.label = r'$u_{CT}$'
+        var.visual.axis[1].lim = [None, None]
+        var.value = u_CT[:, np.newaxis]
+        self['u_CT'] = var
+
+        var = self['u_CROSS'].clone()
+        var.name = 'u_VCT'
+        var.label = r'$u_{VCT}$'
+        var.visual.axis[1].lim = [None, None]
+        var.value = u_VCT[:, np.newaxis]
+        self['u_VCT'] = var
     
     def convert_to_APEX(self):
         import geospacelab.cs as gsl_cs
@@ -199,7 +254,9 @@ class Dataset(datahub.DatasetSourced):
             file_patterns = [
                 'CH',
                 self.product.upper().replace('-', '_'),
-                this_day.strftime('%Y_%m'),
+                this_day.strftime('%Y'),
+                this_day.strftime('%m'),
+                self.product_version,
             ]
             # remove empty str
             file_patterns = [pattern for pattern in file_patterns if str(pattern)]
@@ -221,7 +278,7 @@ class Dataset(datahub.DatasetSourced):
                         search_pattern=search_pattern,
                         allow_multiple_files=False
                     )
-
+        self.data_file_paths = np.unique(self.data_file_paths)
         return done
 
     def download_data(self, dt_fr=None, dt_to=None):
@@ -233,10 +290,11 @@ class Dataset(datahub.DatasetSourced):
             dt_fr, dt_to,
             product=self.product,
             version=self.product_version,
-            force=self.force_download
+            force_download=self.force_download,
+            dry_run=self.download_dry_run
         )
 
-        return download_obj.done
+        return any(download_obj.done)
 
     @property
     def database(self):

geospacelab/datahub/sources/tud/champ/wnd_acc/downloader.py

@@ -8,42 +8,35 @@ __license__ = "BSD-3-Clause License"
 __email__ = "lei.cai@oulu.fi"
 __docformat__ = "reStructureText"
 
+import datetime
 from geospacelab.config import prf
 
-from geospacelab.datahub.sources.tud.downloader import Downloader as DownloaderModel
-
-
-class Downloader(DownloaderModel):
-
-    def __init__(
-            self, dt_fr, dt_to,
-            product='WND-ACC',
-            version='v01',
-            force=True, direct_download=True, **kwargs
-    ):
-        if version == 'v01':
-            v_str = "version_01"
-        elif version == 'v02':
-            raise NotImplementedError
-        else:
-            raise NotImplementedError
-        data_file_root_dir = prf.datahub_data_root_dir / "TUD" / "CHAMP" / product.upper() / version
-        ftp_data_dir = f'{v_str}/CHAMP_data'
-        file_name_patterns = ['CH', product.replace('-', '_')]
-        super(Downloader, self).__init__(
-            dt_fr, dt_to,
-            data_file_root_dir=data_file_root_dir, ftp_data_dir=ftp_data_dir, force=force,
-            direct_download=direct_download, file_name_patterns=file_name_patterns, **kwargs
+from geospacelab.datahub.sources.tud.downloader import TUDownloader as DownloaderBase   
+
+
+class Downloader(DownloaderBase):
+    
+    def __init__(self, 
+        dt_fr, dt_to, 
+        mission='CHAMP', 
+        sat_id='',
+        version='v02',  
+        product='WND-ACC',
+        direct_download=True,
+        force_download=False,
+        dry_run=False,
+        ):
+        self.mission = mission
+        self.version = version
+        
+        super().__init__(
+            dt_fr, dt_to, 
+            mission=mission,
+            sat_id=sat_id, 
+            version=version,
+            product=product,
+            direct_download=direct_download,
+            force_download=force_download,
+            dry_run=dry_run
         )
-
-    def download(self, **kwargs):
-
-        done = super(Downloader, self).download(**kwargs)
-        return done
-
-    def search_files(self, **kwargs):
-
-        file_list = super(Downloader, self).search_files(**kwargs)
-
-        return file_list
-        # version control
+        

geospacelab/datahub/sources/tud/champ/wnd_acc/loader.py

@@ -30,7 +30,7 @@ class Loader(object):
         if self.version == 'v01':
             self.load_v01()
         elif self.version == 'v02':
-            raise NotImplementedError 
+            self.load_v02()
         else:
             raise NotImplementedError
 
@@ -59,10 +59,39 @@ class Loader(object):
             self.variables['SC_ARG_LAT'] = np.array(results[6]).astype(np.float32).reshape(num_rec, 1)
             self.variables['u_CROSS_E'] = np.array(results[7]).astype(np.float32).reshape(num_rec, 1)
             self.variables['u_CROSS_N'] = np.array(results[8]).astype(np.float32).reshape(num_rec, 1)
-            self.variables['u_CROSS_U'] = np.array(results[9]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['u_CROSS'] = - np.array(results[9]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['u_CROSS_D'] = np.zeros_like(self.variables['u_CROSS'])
+
+            self.variables['UNIT_VECTOR_N'] = self.variables['u_CROSS_N'] / self.variables['u_CROSS']
+            self.variables['UNIT_VECTOR_E'] = self.variables['u_CROSS_E'] / self.variables['u_CROSS']
+            self.variables['UNIT_VECTOR_D'] = self.variables['u_CROSS_D'] / self.variables['u_CROSS']
             
-            self.variables['u_CROSS'] = np.sqrt(
-                self.variables['u_CROSS_E']**2
-                + self.variables['u_CROSS_N']**2
-                + self.variables['u_CROSS_U']**2
-            )
+    def load_v02(self):
+        with open(self.file_path, 'r') as f:
+            text = f.read()
+            results = re.findall(
+                r"^(\d{4}-\d{2}-\d{2}\s*\d{2}\:\d{2}\:\d{2}\.\d{3})\s*(\w{3})\s*"
+                + r"([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)\s*"
+                + r"([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)\s*([\-\d.]+)",
+                text,
+                re.M)
+            results = list(zip(*results))
+            dts = [datetime.datetime.strptime(dtstr + '000', "%Y-%m-%d %H:%M:%S.%f") for dtstr in results[0]]
+            if results[1][0] == 'GPS':
+                t_gps = [(dt - dttool._GPS_DATETIME_0).total_seconds() for dt in dts]
+                dts = dttool.convert_gps_time_to_datetime(t_gps, weeks=None)
+            num_rec = len(dts)
+            self.variables['SC_DATETIME'] = np.array(dts).reshape(num_rec, 1)
+            self.variables['SC_GEO_ALT'] = np.array(results[2]).astype(np.float32).reshape(num_rec, 1) * 1e-3   # in km
+            self.variables['SC_GEO_LON'] = np.array(results[3]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['SC_GEO_LAT'] = np.array(results[4]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['SC_GEO_LST'] = np.array(results[5]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['SC_ARG_LAT'] = np.array(results[6]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['u_CROSS'] = np.array(results[7]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['UNIT_VECTOR_N'] = np.array(results[8]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['UNIT_VECTOR_E'] = np.array(results[9]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['UNIT_VECTOR_D'] = np.array(results[10]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['FLAG'] = np.array(results[6]).astype(np.float32).reshape(num_rec, 1)
+            self.variables['u_CROSS_E'] = self.variables['u_CROSS'] * self.variables['UNIT_VECTOR_E']
+            self.variables['u_CROSS_N'] = self.variables['u_CROSS'] * self.variables['UNIT_VECTOR_N']
+            self.variables['u_CROSS_D'] = self.variables['u_CROSS'] * self.variables['UNIT_VECTOR_D']

geospacelab/datahub/sources/tud/champ/wnd_acc/variable_config.py

@@ -116,11 +116,11 @@ axis[1].unit = '@v.unit_label'
 configured_variables[var_name] = var
 
 ####################################################################################################################
-var_name = 'u_CROSS_U'
+var_name = 'u_CROSS_D'
 var = Var(name=var_name, ndim=1, variable_type='scalar', visual=visual)
 # set variable attrs
-var.fullname = 'Cross neutral wind (Upward)'
-var.label = r'$u_{Up}$'
+var.fullname = 'Cross neutral wind (Downward)'
+var.label = r'$u_{Down}$'
 var.unit = 'm/s'
 var.unit_label = r'm/s'
 var.group = r'$u$'