geospacelab 0.9.2__tar.gz → 0.9.4__tar.gz

{geospacelab-0.9.2/geospacelab.egg-info → geospacelab-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geospacelab
-Version: 0.9.2
+Version: 0.9.4
 Summary: Collect, manage, and visualize geospace data.
 Home-page: https://github.com/JouleCai/geospacelab
 Author: Lei Cai
@@ -104,6 +104,7 @@ on [readthedocs.io](https://geospacelab.readthedocs.io/en/latest/).
 | Data Source                  | Variables                          | File Format           | Downloadable  | Express                       | Status | 
 |------------------------------|------------------------------------|-----------------------|---------------|-------------------------------|--------|
 | CDAWeb/OMNI                  | Solar wind and IMF                 |*cdf*                 | *True*        | __OMNIDashboard__             | stable |
+| CDAWeb/DMSP/SSUSI/EDR_AUR    | DMSP SSUSI EDR_AUR emission lines  | *netcdf*              | *True*        | __DMSPSSUSIDashboard__        | stable |
 | Madrigal/EISCAT              | Ionospheric Ne, Te, Ti, ...        | *EISCAT-hdf5*, *Madrigal-hdf5* | *True* | __EISCATDashboard__           | stable |
 | Madrigal/GNSS/TECMAP         | Ionospheric GPS TEC map            | *hdf5*                | *True*        | -                             | beta   |
 | Madrigal/DMSP/s1             | DMSP SSM, SSIES, etc               | *hdf5*                | *True*        | __DMSPTSDashboard__           | stable |
@@ -111,7 +112,6 @@ on [readthedocs.io](https://geospacelab.readthedocs.io/en/latest/).
 | Madrigal/DMSP/e              | DMSP SSJ                           | *hdf5*                | *True*        | __DMSPTSDashboard__           | stable |
 | Madrigal/Millstone Hill ISR+ | Millstone Hill ISR                 | *hdf5*                | *True*        | __MillstoneHillISRDashboard__ | stable |
 | Madrigal/Poker Flat ISR      | Poker Flat ISR                     | *hdf5*                | *True*        | __-_                          | stable |
-| JHUAPL/DMSP/SSUSI            | DMSP SSUSI                         | *netcdf*              | *True*        | __DMSPSSUSIDashboard__        | stable |
 | JHUAPL/AMPERE/fitted         | AMPERE FAC                         | *netcdf*              | *False*        | __AMPEREDashboard__           | stable |
 | SuperDARN/POTMAP             | SuperDARN potential map            | *ascii*             | *False*       | -                             | stable |                  
 | WDC/Dst                      | Dst index                          | *IAGA2002-ASCII*      | *True*        | -                             | stable |
@@ -374,6 +374,9 @@ Output:
 > ![alt text](https://github.com/JouleCai/geospacelab/blob/master/examples/OMNI_1min_20160314-060000-20160320-060000.png?raw=true)
 
 ### Example 4: Mapping geospatial data in the polar map.
+> **_NOTE_**: JHUAPL stopped supporting DMSP SSUSI on 14 Feb 2025. 
+From then on, the data source has been switched from JHUAPL to CDAWeb.
+ 
 ```python
 import datetime
 import matplotlib.pyplot as plt

{geospacelab-0.9.2 → geospacelab-0.9.4}/README.md

@@ -48,6 +48,7 @@ on [readthedocs.io](https://geospacelab.readthedocs.io/en/latest/).
 | Data Source                  | Variables                          | File Format           | Downloadable  | Express                       | Status | 
 |------------------------------|------------------------------------|-----------------------|---------------|-------------------------------|--------|
 | CDAWeb/OMNI                  | Solar wind and IMF                 |*cdf*                 | *True*        | __OMNIDashboard__             | stable |
+| CDAWeb/DMSP/SSUSI/EDR_AUR    | DMSP SSUSI EDR_AUR emission lines  | *netcdf*              | *True*        | __DMSPSSUSIDashboard__        | stable |
 | Madrigal/EISCAT              | Ionospheric Ne, Te, Ti, ...        | *EISCAT-hdf5*, *Madrigal-hdf5* | *True* | __EISCATDashboard__           | stable |
 | Madrigal/GNSS/TECMAP         | Ionospheric GPS TEC map            | *hdf5*                | *True*        | -                             | beta   |
 | Madrigal/DMSP/s1             | DMSP SSM, SSIES, etc               | *hdf5*                | *True*        | __DMSPTSDashboard__           | stable |
@@ -55,7 +56,6 @@ on [readthedocs.io](https://geospacelab.readthedocs.io/en/latest/).
 | Madrigal/DMSP/e              | DMSP SSJ                           | *hdf5*                | *True*        | __DMSPTSDashboard__           | stable |
 | Madrigal/Millstone Hill ISR+ | Millstone Hill ISR                 | *hdf5*                | *True*        | __MillstoneHillISRDashboard__ | stable |
 | Madrigal/Poker Flat ISR      | Poker Flat ISR                     | *hdf5*                | *True*        | __-_                          | stable |
-| JHUAPL/DMSP/SSUSI            | DMSP SSUSI                         | *netcdf*              | *True*        | __DMSPSSUSIDashboard__        | stable |
 | JHUAPL/AMPERE/fitted         | AMPERE FAC                         | *netcdf*              | *False*        | __AMPEREDashboard__           | stable |
 | SuperDARN/POTMAP             | SuperDARN potential map            | *ascii*             | *False*       | -                             | stable |                  
 | WDC/Dst                      | Dst index                          | *IAGA2002-ASCII*      | *True*        | -                             | stable |
@@ -318,6 +318,9 @@ Output:
 > ![alt text](https://github.com/JouleCai/geospacelab/blob/master/examples/OMNI_1min_20160314-060000-20160320-060000.png?raw=true)
 
 ### Example 4: Mapping geospatial data in the polar map.
+> **_NOTE_**: JHUAPL stopped supporting DMSP SSUSI on 14 Feb 2025. 
+From then on, the data source has been switched from JHUAPL to CDAWeb.
+ 
 ```python
 import datetime
 import matplotlib.pyplot as plt

{geospacelab-0.9.2 → geospacelab-0.9.4}/geospacelab/__init__.py

@@ -6,7 +6,7 @@ __author__ = "Lei Cai"
 __copyright__ = "Copyright 2021, GeospaceLAB"
 __credits__ = ["Lei Cai"]
 __license__ = "BSD-3-Clause License"
-__version__ = "0.9.2"
+__version__ = "0.9.4"
 __maintainer__ = "Lei Cai"
 __email__ = "lei.cai@oulu.fi"
 __status__ = "Developing"

geospacelab-0.9.4/geospacelab/datahub/sources/cdaweb/dmsp/ssusi/edr_aur/__init__.py

@@ -0,0 +1,234 @@
+# Licensed under the BSD 3-Clause License
+# Copyright (C) 2021 GeospaceLab (geospacelab)
+# Author: Lei Cai, Space Physics and Astronomy, University of Oulu
+
+import datetime
+
+import numpy as np
+
+import geospacelab.datahub as datahub
+from geospacelab.datahub import DatabaseModel, FacilityModel, InstrumentModel, ProductModel
+from geospacelab.datahub.sources.cdaweb import cdaweb_database
+from geospacelab.config import prf
+import geospacelab.toolbox.utilities.pydatetime as dttool
+import geospacelab.toolbox.utilities.pybasic as basic
+import geospacelab.toolbox.utilities.pylogging as mylog
+from geospacelab.datahub.sources.cdaweb.dmsp.ssusi.edr_aur.loader import Loader as default_Loader
+from geospacelab.datahub.sources.cdaweb.dmsp.ssusi.edr_aur.downloader import Downloader as default_Downloader
+import geospacelab.datahub.sources.cdaweb.dmsp.ssusi.edr_aur.variable_config as var_config
+
+
+default_dataset_attrs = {
+    'database': cdaweb_database,
+    'facility': 'DMSP',
+    'instrument': 'SSUSI',
+    'product': 'EDR_AUR',
+    'data_file_ext': 'nc',
+    'data_root_dir': prf.datahub_data_root_dir / 'CDAWeb' / 'DMSP' / 'SSUSI' / 'EDR_AUR',
+    'allow_load': True,
+    'allow_download': True,
+    'data_search_recursive': False,
+    'label_fields': ['database', 'facility', 'instrument', 'product'],
+    'time_clip': False,
+}
+
+default_variable_names = [
+    'DATETIME', 'STARTING_TIME', 'STOPPING_TIME',
+    'GRID_MLAT', 'GRID_MLON', 'GRID_MLT', 'GRID_UT',
+    'GRID_AUR_1216', 'GRID_AUR_1304', 'GRID_AUR_1356', 'GRID_AUR_LBHS', 'GRID_AUR_LBHL',
+]
+
+# default_data_search_recursive = True
+
+default_attrs_required = []
+
+
+class Dataset(datahub.DatasetSourced):
+    def __init__(self, **kwargs):
+        kwargs = basic.dict_set_default(kwargs, **default_dataset_attrs)
+
+        super().__init__(**kwargs)
+
+        self.database = kwargs.pop('database', 'CDAWeb')
+        self.facility = kwargs.pop('facility', 'DMSP')
+        self.instrument = kwargs.pop('instrument', 'SSUSI')
+        self.product = kwargs.pop('product', 'EDR-EUR')
+        self.allow_download = kwargs.pop('allow_download', True)
+
+        self.sat_id = kwargs.pop('sat_id', '')
+        self.orbit_id = kwargs.pop('orbit_id', None)
+        self.pole = kwargs.pop('pole', '')
+
+        self.metadata = None
+
+        allow_load = kwargs.pop('allow_load', False)
+
+        # self.config(**kwargs)
+
+        if self.loader is None:
+            self.loader = default_Loader
+
+        if self.downloader is None:
+            self.downloader = default_Downloader
+
+        self._validate_attrs()
+
+        if allow_load:
+            self.load_data()
+
+    def _validate_attrs(self):
+        for attr_name in default_attrs_required:
+            attr = getattr(self, attr_name)
+            if not str(attr):
+                mylog.StreamLogger.warning("The parameter {} is required before loading data!".format(attr_name))
+
+    def label(self, **kwargs):
+        label = super().label()
+        return label
+
+    def load_data(self, **kwargs):
+        self.check_data_files(**kwargs)
+
+        self._set_default_variables(
+            default_variable_names,
+            configured_variables=var_config.configured_variables
+        )
+        for file_path in self.data_file_paths:
+            try:
+                load_obj = self.loader(file_path, file_type=self.product.lower(), pole=self.pole)
+            except Exception as e:
+                mylog.StreamLogger.warning(("Cannot load the data file: {}".format(file_path)))
+                print(e)
+            for var_name in self._variables.keys():
+                if var_name == 'EMISSION_SPECTRA':
+                    self._variables[var_name].value = load_obj.variables[var_name]
+                    continue
+                if var_name in ['DATETIME', 'STARTING_TIME', 'STOPPING_TIME']:
+                    value = np.array([load_obj.variables[var_name]])[np.newaxis, :]
+                else:
+                    value = np.empty((1, ), dtype=object)
+                    value[0] = load_obj.variables[var_name]
+                    # value = load_obj.variables[var_name][np.newaxis, ::]
+                self._variables[var_name].join(value)
+
+            self.orbit_id = load_obj.metadata['ORBIT_ID']
+            # self.select_beams(field_aligned=True)
+        if self.time_clip:
+            self.time_filter_by_range()
+
+    def get_time_ind(self, ut, time_res=20*60, var_datetime_name='DATETIME', edge_cutoff=False, **kwargs):
+        ind = super().get_time_ind(ut, time_res=time_res, var_datetime_name=var_datetime_name, edge_cutoff=edge_cutoff, **kwargs)
+        return ind
+
+    def search_data_files(self, **kwargs):
+        dt_fr_1 = self.dt_fr - datetime.timedelta(hours=3)
+        dt_to_1 = self.dt_to + datetime.timedelta(hours=3)
+
+        diff_days = dttool.get_diff_days(dt_fr_1, dt_to_1)
+        
+        dt0 = dttool.get_start_of_the_day(dt_fr_1)
+        for i in range(diff_days + 1):
+            thisday = dt0 + datetime.timedelta(days=i)
+            initial_file_dir = kwargs.pop('initial_file_dir', None)
+            if initial_file_dir is None:
+                initial_file_dir = self.data_root_dir / self.sat_id.upper() / str(thisday.year) /thisday.strftime("%Y%m%d")
+
+            file_patterns = [
+                'dmsp' + self.sat_id.lower(),
+                'edr-aurora',
+                thisday.strftime("%Y%j") + 'T',
+            ]
+
+            if self.orbit_id is not None:
+                file_patterns.extend(['REV', self.orbit_id])
+                multiple_files = False
+            else:
+                multiple_files = True
+            # remove empty str
+            file_patterns = [pattern for pattern in file_patterns if str(pattern)]
+
+            search_pattern = '*' + '*'.join(file_patterns) + '*'
+
+            done = super().search_data_files(
+                initial_file_dir=initial_file_dir,
+                search_pattern=search_pattern,
+                allow_multiple_files=multiple_files,
+            )
+            if done and self.orbit_id is not None:
+                return True
+
+            # Validate file paths
+
+            if not done and self.allow_download:
+                done = self.download_data(dt_fr=thisday, dt_to=thisday)
+                if done:
+                    done = super().search_data_files(
+                        initial_file_dir=initial_file_dir,
+                        search_pattern=search_pattern,
+                        allow_multiple_files=multiple_files
+                    )
+
+        return done
+
+    def download_data(self, dt_fr=None, dt_to=None):
+        if dt_fr is None:
+            dt_fr = self.dt_fr
+        if dt_to is None:
+            dt_to = self.dt_to
+        download_obj = self.downloader(
+            dt_fr, dt_to,
+            orbit_id=self.orbit_id, sat_id=self.sat_id,
+        )
+        return download_obj.done
+
+    @property
+    def database(self):
+        return self._database
+
+    @database.setter
+    def database(self, value):
+        if isinstance(value, str):
+            self._database = DatabaseModel(value)
+        elif issubclass(value.__class__, DatabaseModel):
+            self._database = value
+        else:
+            raise TypeError
+
+    @property
+    def product(self):
+        return self._product
+
+    @product.setter
+    def product(self, value):
+        if isinstance(value, str):
+            self._product = ProductModel(value)
+        elif issubclass(value.__class__, ProductModel):
+            self._product = value
+        else:
+            raise TypeError
+
+    @property
+    def facility(self):
+        return self._facility
+
+    @facility.setter
+    def facility(self, value):
+        if isinstance(value, str):
+            self._facility = FacilityModel(value)
+        elif issubclass(value.__class__, FacilityModel):
+            self._facility = value
+        else:
+            raise TypeError
+
+    @property
+    def instrument(self):
+        return self._instrument
+
+    @instrument.setter
+    def instrument(self, value):
+        if isinstance(value, str):
+            self._instrument = InstrumentModel(value)
+        elif issubclass(value.__class__, InstrumentModel):
+            self._instrument = value
+        else:
+            raise TypeError

geospacelab-0.9.4/geospacelab/datahub/sources/cdaweb/dmsp/ssusi/edr_aur/downloader.py

@@ -0,0 +1,93 @@
+import datetime
+import pathlib
+import copy
+
+import geospacelab.toolbox.utilities.pydatetime as dttool
+import geospacelab.toolbox.utilities.pylogging as mylog
+from geospacelab.config import prf
+from geospacelab.datahub.sources.cdaweb.downloader import Downloader as DownloaderBase
+
+
+class Downloader(DownloaderBase):
+    
+    def __init__(
+            self,
+            dt_fr=None, dt_to=None,
+            sat_id=None,
+            orbit_id=None,
+            direct_download=True,
+            force_download=False,
+            data_file_root_dir = None,
+            dry_run=False,
+        ):
+        product = 'EDR_AUR'
+        if data_file_root_dir is None:
+            data_file_root_dir = prf.datahub_data_root_dir / 'CDAWeb' / 'DMSP' / 'SSUSI' /product / sat_id.upper()
+        self.sat_id = sat_id
+        self.orbit_id = orbit_id
+        self.source_subdirs = ['dmsp', 'dmsp'+self.sat_id.lower(), 'ssusi', 'data', 'edr-aurora']
+
+        super().__init__(
+            dt_fr, dt_to,
+            data_file_root_dir=data_file_root_dir,
+            direct_download=direct_download,force_download=force_download,dry_run=dry_run
+        )
+
+
+    def search_from_http(self, file_name_patterns=None, allow_multiple_files=True):
+
+        dt_fr_1 = self.dt_fr - datetime.timedelta(hours=3)
+        dt_to_1 = self.dt_to + datetime.timedelta(hours=3)
+        diff_days = dttool.get_diff_days(dt_fr_1, dt_to_1)
+        dt0 = dttool.get_start_of_the_day(dt_fr_1)
+        source_file_paths = []
+        for nd in range(diff_days + 1):
+            this_day = dt0 + datetime.timedelta(days=nd)
+            doy = dttool.get_doy(this_day)
+            sdoy = '{:03d}'.format(doy)
+            subdirs = copy.deepcopy(self.source_subdirs)
+            subdirs.extend(
+                [str(this_day.year), sdoy]
+            )
+
+            if self.orbit_id is None:
+                file_name_patterns = [
+                    'dmsp' + self.sat_id.lower(),
+                    'ssusi',
+                    'edr-aurora',
+                    this_day.strftime("%Y") + sdoy + 'T',
+                    '.nc'
+                ]
+            else:
+                file_name_patterns = [
+                    'dmsp' + self.sat_id.lower(),
+                    'ssusi',
+                    'edr-aurora',
+                    'REV',
+                    self.orbit_id,
+                    '.nc'
+                ]
+            paths = super().search_from_http(subdirs=subdirs, file_name_patterns=file_name_patterns)
+            source_file_paths.extend(paths)
+        return source_file_paths
+
+    def save_file_from_http(self, url, file_dir=None, file_name=None):
+
+        sy = url.split('/')[-3]
+        sdoy = url.split('/')[-2]
+        year = int(sy)
+        this_day = dttool.convert_doy_to_datetime(year, int(sdoy))
+        if file_dir is None:
+            file_dir = self.data_file_root_dir / sy / this_day.strftime("%Y%m%d")
+        super().save_file_from_http(url, file_dir=file_dir)
+
+
+
+if __name__ == "__main__":
+    downloader = Downloader(
+        dt_fr = datetime.datetime(2011, 1, 6),
+        dt_to = datetime.datetime(2011, 1, 6, 12),
+        sat_id='F17',
+        orbit_id='21523',
+        dry_run=False,
+    )

geospacelab-0.9.4/geospacelab/datahub/sources/cdaweb/dmsp/ssusi/edr_aur/loader.py

@@ -0,0 +1,112 @@
+# Licensed under the BSD 3-Clause License
+# Copyright (C) 2021 GeospaceLab (geospacelab)
+# Author: Lei Cai, Space Physics and Astronomy, University of Oulu
+
+import netCDF4
+import datetime
+import numpy as np
+import geospacelab.toolbox.utilities.pydatetime as dttool
+
+
+class Loader(object):
+
+    def __init__(self, file_path, file_type='edr-aur', pole='N'):
+
+        self.variables = {}
+        self.metadata = {}
+        self.file_path = file_path
+        self.file_type = file_type
+        self.pole = pole
+
+        self.load_data()
+
+    def load_data(self):
+        dataset = netCDF4.Dataset(self.file_path)
+        variables = {}
+        metadata = {}
+
+        if self.pole == 'N':
+            pole = self.pole
+            pole_str = 'NORTH'
+        elif self.pole == 'S':
+            pole = self.pole
+            pole_str = 'SOUTH'
+        else:
+            raise ValueError
+        # Time and Position
+        # sectime = int(np.array(dataset.variables['TIME']).flatten()[0])
+        # doy = int(np.array(dataset.variables['DOY']).flatten()[0])
+        # year = int(np.array(dataset.variables['YEAR']).flatten()[0])
+        # dt0 = dttool.convert_doy_to_datetime(year, doy)
+        starting_time = datetime.datetime.strptime(dataset.STARTING_TIME, "%Y%j%H%M%S")
+        variables['STARTING_TIME'] = starting_time
+        stopping_time = datetime.datetime.strptime(dataset.STOPPING_TIME, "%Y%j%H%M%S")
+        variables['STOPPING_TIME'] = stopping_time
+        dt0 = dttool.get_start_of_the_day(starting_time)
+
+        variables['SC_LAT'] = np.array(dataset.variables['LATITUDE'])
+        variables['SC_LON'] = np.array(dataset.variables['LONGITUDE'])
+        variables['SC_ALT'] = np.array(dataset.variables['ALTITUDE'])
+
+        variables['GRID_MLAT'] = np.array(dataset.variables['LATITUDE_GEOMAGNETIC_GRID_MAP'])
+        variables['GRID_MLON'] = np.array(
+            dataset.variables['LONGITUDE_GEOMAGNETIC_' + pole_str + '_GRID_MAP'])
+        variables['GRID_MLT'] = np.array(dataset.variables['MLT_GRID_MAP'])
+        if self.pole == 'S':
+            variables['GRID_MLAT'] = - variables['GRID_MLAT']
+        variables['GRID_UT'] = np.array(dataset.variables['UT_' + pole])
+        lat = np.array(variables['GRID_MLAT'])
+        ut = np.array(variables['GRID_UT'])
+        lat = np.where(ut == 0, np.nan, lat)
+        if self.pole == 'N':
+            ind_mid_t = np.where(lat == np.nanmax(lat.flatten()))
+        else:
+            ind_mid_t = np.where(lat == np.nanmin(lat.flatten()))
+        sectime0 = variables['GRID_UT'][ind_mid_t][0] * 3600
+
+        diff_days = dttool.get_diff_days(starting_time, stopping_time)
+        if diff_days > 0 and sectime0 < 0.5 * 86400.:
+            dt = dt0 + datetime.timedelta(seconds=int(sectime0 + 86400))
+        else:
+            dt = dt0 + datetime.timedelta(seconds=int(sectime0))
+        variables['DATETIME'] = dt
+
+        invalid_ut_inds = np.where(ut == 0)
+        # Auroral map, #colors: 0: '1216', 1: '1304', 2: '1356', 3: 'LBHS', 4: 'LBHL'.
+        variables['EMISSION_SPECTRA'] = ['1216', '1304', '1356', 'LBHS', 'LBHL']
+        disk_aur = np.array(dataset.variables['DISK_RADIANCEDATA_INTENSITY_' + pole_str])
+        # disk_aur[:, invalid_ut_inds] = np.nan
+        disk_aur[disk_aur <= 0] = 0.1
+        variables['GRID_AUR_1216'] = disk_aur[0, ::]
+        variables['GRID_AUR_1216'][invalid_ut_inds] = np.nan
+        variables['GRID_AUR_1304'] = disk_aur[1, ::]
+        variables['GRID_AUR_1304'][invalid_ut_inds] = np.nan
+        variables['GRID_AUR_1356'] = disk_aur[2, ::]
+        variables['GRID_AUR_1356'][invalid_ut_inds] = np.nan
+        variables['GRID_AUR_LBHS'] = disk_aur[3, ::]
+        variables['GRID_AUR_LBHS'][invalid_ut_inds] = np.nan
+        variables['GRID_AUR_LBHL'] = disk_aur[4, ::]
+        variables['GRID_AUR_LBHL'][invalid_ut_inds] = np.nan
+
+        # Auroral oval boundary
+        variables['AOB_EQ_MLAT'] = np.array(dataset.variables[pole_str + '_GEOMAGNETIC_LATITUDE'])
+        variables['AOB_EQ_MLON'] = np.array(dataset.variables[pole_str + '_GEOMAGNETIC_LONGITUDE'])
+        variables['AOB_EQ_MLT'] = np.array(dataset.variables[pole_str + '_MAGNETIC_LOCAL_TIME'])
+
+        variables['AOB_PL_MLAT'] = np.array(dataset.variables[pole_str + '_POLAR_GEOMAGNETIC_LATITUDE'])
+        variables['AOB_PL_MLON'] = np.array(dataset.variables[pole_str + '_POLAR_GEOMAGNETIC_LONGITUDE'])
+        variables['AOB_PL_MLT'] = np.array(dataset.variables[pole_str + '_POLAR_MAGNETIC_LOCAL_TIME'])
+
+        variables['MAOB_EQ_MLAT'] = np.array(dataset.variables['MODEL_' + pole_str + '_GEOMAGNETIC_LATITUDE'])
+        variables['MAOB_EQ_MLON'] = np.array(dataset.variables['MODEL_' + pole_str + '_GEOMAGNETIC_LONGITUDE'])
+        variables['MAOB_EQ_MLT'] = np.array(dataset.variables['MODEL_' + pole_str + '_MAGNETIC_LOCAL_TIME'])
+
+        variables['MAOB_PL_MLAT'] = np.array(dataset.variables['MODEL_' + pole_str + '_POLAR_GEOMAGNETIC_LATITUDE'])
+        variables['MAOB_PL_MLON'] = np.array(dataset.variables['MODEL_' + pole_str + '_POLAR_GEOMAGNETIC_LONGITUDE'])
+        variables['MAOB_PL_MLT'] = np.array(dataset.variables['MODEL_' + pole_str + '_POLAR_MAGNETIC_LOCAL_TIME'])
+
+        metadata.setdefault('ORBIT_ID', dataset.STARTING_ORBIT_NUMBER)
+        dataset.close()
+
+        self.variables = variables
+        self.metadata = metadata

geospacelab-0.9.4/geospacelab/datahub/sources/cdaweb/dmsp/ssusi/edr_aur/variable_config.py

@@ -0,0 +1,139 @@
+# Licensed under the BSD 3-Clause License
+# Copyright (C) 2021 GeospaceLab (geospacelab)
+# Author: Lei Cai, Space Physics and Astronomy, University of Oulu
+
+__author__ = "Lei Cai"
+__copyright__ = "Copyright 2021, GeospaceLab"
+__license__ = "BSD-3-Clause License"
+__email__ = "lei.cai@oulu.fi"
+__docformat__ = "reStructureText"
+
+from geospacelab.datahub import VariableModel as Var
+import geospacelab.visualization.mpl.colormaps as cm
+
+database = 'jhuapl'
+
+timestamps = {
+    'DATETIME': 'DATETIME',
+}
+
+
+default_colormap = cm.cmap_aurora()
+
+default_plot_config = {
+    'line':         {
+        'linestyle':        '-',
+        'linewidth':        1.5,
+        'marker':           '',
+        'markersize':       3,
+    },
+    'pcolormesh':   {
+        'cmap':            default_colormap,
+        'c_scale':         'log',
+        'c_lim':           [50, 6000],
+        'alpha':            0.9,
+    }
+}
+
+configured_variables = {}
+visual = 'on'
+
+depend_0 = {'UT': 'DATETIME'}
+depend_1 = {'AACGM_LAT': 'GRID_MLAT'}
+depend_2 = {'AACGM_LON': 'GRID_MLON'}
+depend_c = {'SPECTRA': 'EMISSION_SPECTRA'}
+
+####################################################################################################################
+var_name = 'GRID_AUR_LBHS'
+var = Var(name=var_name, ndim=3, variable_type='scalar', visual=visual)
+# set variable attrs
+var.fullname = 'Auroral emission intensity at LBHS'
+var.label = r'LBHS'
+var.group = 'Emission intensity'
+var.unit = 'R'
+var.depends = {0: depend_0, 1: {'AACGM_LAT': 'GRID_MLAT'}, 2: {'AACGM_LON': 'GRID_MLON'}}
+# set plot attrs
+plot_config = var.visual.plot_config
+plot_config.config(**default_plot_config)
+plot_config.style = '2P'
+# set axis attrs
+axis = var.visual.axis
+
+
+configured_variables[var_name] = var
+
+####################################################################################################################
+var_name = 'GRID_AUR_LBHL'
+var = Var(name=var_name, ndim=3, variable_type='scalar', visual=visual)
+# set variable attrs
+var.fullname = 'Auroral emission intensity at LBHL'
+var.label = r'LBHL'
+var.group = 'Emission intensity'
+var.unit = 'R'
+var.depends = {0: depend_0, 1: {'AACGM_LAT': 'GRID_MLAT'}, 2: {'AACGM_LON': 'GRID_MLON'}}
+# set plot attrs
+plot_config = var.visual.plot_config
+plot_config.config(**default_plot_config)
+plot_config.style = '2P'
+# set axis attrs
+axis = var.visual.axis
+
+
+configured_variables[var_name] = var
+
+####################################################################################################################
+var_name = 'GRID_AUR_1304'
+var = Var(name=var_name, ndim=3, variable_type='scalar', visual=visual)
+# set variable attrs
+var.fullname = 'Auroral emission intensity at 130.4 nm'
+var.label = r'1304'
+var.group = 'Emission intensity'
+var.unit = 'R'
+var.depends = {0: depend_0, 1: {'AACGM_LAT': 'GRID_MLAT'}, 2: {'AACGM_LON': 'GRID_MLON'}}
+# set plot attrs
+plot_config = var.visual.plot_config
+plot_config.config(**default_plot_config)
+plot_config.style = '2P'
+# set axis attrs
+axis = var.visual.axis
+
+
+configured_variables[var_name] = var
+
+####################################################################################################################
+var_name = 'GRID_AUR_1356'
+var = Var(name=var_name, ndim=3, variable_type='scalar', visual=visual)
+# set variable attrs
+var.fullname = 'Auroral emission intensity at 135.6 nm'
+var.label = r'1356'
+var.group = 'Emission intensity'
+var.unit = 'R'
+var.depends = {0: depend_0, 1: {'AACGM_LAT': 'GRID_MLAT'}, 2: {'AACGM_LON': 'GRID_MLON'}}
+# set plot attrs
+plot_config = var.visual.plot_config
+plot_config.config(**default_plot_config)
+plot_config.style = '2P'
+# set axis attrs
+axis = var.visual.axis
+
+
+configured_variables[var_name] = var
+
+####################################################################################################################
+var_name = 'GRID_AUR_1216'
+var = Var(name=var_name, ndim=3, variable_type='scalar', visual=visual)
+# set variable attrs
+var.fullname = 'Auroral emission intensity at 121.6 nm'
+var.label = r'1216'
+var.group = 'Emission intensity'
+var.unit = 'R'
+var.depends = {0: depend_0, 1: {'AACGM_LAT': 'GRID_MLAT'}, 2: {'AACGM_LON': 'GRID_MLON'}}
+# set plot attrs
+plot_config = var.visual.plot_config
+plot_config.config(**default_plot_config)
+plot_config.style = '2P'
+# set axis attrs
+axis = var.visual.axis
+
+
+configured_variables[var_name] = var