Merge pull request #132 from pysat/maint_try_except_data

MAINT: support for pysat behaviour changes
pysat · Oct 24, 2023 · 1a44957 · 1a44957
2 parents baaf37e + cc4c9ff
commit 1a44957
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
   * Updated package documentation, yamls, and other supporting files
   * Updated the LISIRD download routine to reflect new behaviour
   * Changed F10.7 daily test day to ensure new pysat padding tests work
+  * Removed try/except loop that was a fix for pysat < 3.1.0
+  * Updated 'use_header' kwarg use for pysat 3.2.0 changes
 
 [0.0.10] - 2023-06-01
 ---------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -97,6 +97,9 @@
 # a list of builtin themes.
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = ["_themes", ]
+html_logo = os.path.join(os.path.abspath('.'), 'figures',
+                         'pysatSpaceWeather.png')
+html_theme_options = {'logo_only': True}
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,7 +9,7 @@ routines to load common historic, real-time, and forecasted space weather
 indices as pysat.Instrument objects.
 
 .. toctree::
-   :maxdepth: -1
+   :maxdepth: 2
 
    overview.rst
    installation.rst

diff --git a/pysatSpaceWeather/instruments/methods/f107.py b/pysatSpaceWeather/instruments/methods/f107.py
@@ -166,7 +166,10 @@ def combine_f107(standard_inst, forecast_inst, start=None, stop=None):
                 # Set the load kwargs, which vary by pysat version and tag
                 load_kwargs = {'date': itime}
 
-                if Version(pysat.__version__) > Version('3.0.1'):
+                # TODO(#131): Remove version check after minimum version
+                # supported is 3.2.0
+                if all([Version(pysat.__version__) > Version('3.0.1'),
+                        Version(pysat.__version__) < Version('3.2.0')]):
                     load_kwargs['use_header'] = True
 
                 if standard_inst.tag == 'daily':
@@ -214,7 +217,11 @@ def combine_f107(standard_inst, forecast_inst, start=None, stop=None):
             for filename in files:
                 if filename is not None:
                     load_kwargs = {'fname': filename}
-                    if Version(pysat.__version__) > Version('3.0.1'):
+
+                    # TODO(#131): Remove version check after minimum version
+                    # supported is 3.2.0
+                    if all([Version(pysat.__version__) > Version('3.0.1'),
+                            Version(pysat.__version__) < Version('3.2.0')]):
                         load_kwargs['use_header'] = True
 
                     forecast_inst.load(**load_kwargs)

diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py
@@ -368,15 +368,14 @@ def filter_geomag(inst, min_kp=0, max_kp=9, filter_time=24, kp_inst=None,
     if kp_inst.empty:
         load_kwargs = {'date': inst.index[0], 'end_date': inst.index[-1],
                        'verifyPad': True}
-        if Version(pysat.__version__) > Version('3.0.1'):
+
+        # TODO(#131): Remove version check after minimum version supported
+        # is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
-        # TODO(#117): This gets around a bug in pysat that will be fixed in
-        # pysat version 3.1.0+
-        try:
-            kp_inst.load(**load_kwargs)
-        except TypeError:
-            pass
+        kp_inst.load(**load_kwargs)
 
     if kp_inst.empty:
         raise IOError(
@@ -598,7 +597,11 @@ def combine_kp(standard_inst=None, recent_inst=None, forecast_inst=None,
         # Load and save the standard data for as many times as possible
         if inst_flag == 'standard':
             load_kwargs = {'date': itime}
-            if Version(pysat.__version__) > Version('3.0.1'):
+
+            # TODO(#131): Remove version check after minimum version supported
+            # is 3.2.0
+            if all([Version(pysat.__version__) > Version('3.0.1'),
+                    Version(pysat.__version__) < Version('3.2.0')]):
                 load_kwargs['use_header'] = True
 
             standard_inst.load(**load_kwargs)
@@ -628,7 +631,11 @@ def combine_kp(standard_inst=None, recent_inst=None, forecast_inst=None,
             for filename in files:
                 if filename is not None:
                     load_kwargs = {'fname': filename}
-                    if Version(pysat.__version__) > Version('3.0.1'):
+
+                    # TODO(#131): Remove version check after minimum version
+                    # supported is 3.2.0
+                    if all([Version(pysat.__version__) > Version('3.0.1'),
+                            Version(pysat.__version__) < Version('3.2.0')]):
                         load_kwargs['use_header'] = True
                     recent_inst.load(**load_kwargs)
 
@@ -664,7 +671,11 @@ def combine_kp(standard_inst=None, recent_inst=None, forecast_inst=None,
             for filename in files:
                 if filename is not None:
                     load_kwargs = {'fname': filename}
-                    if Version(pysat.__version__) > Version('3.0.1'):
+
+                    # TODO(#131): Remove version check after minimum version
+                    # supported is 3.2.0
+                    if all([Version(pysat.__version__) > Version('3.0.1'),
+                            Version(pysat.__version__) < Version('3.2.0')]):
                         load_kwargs['use_header'] = True
                     forecast_inst.load(**load_kwargs)
 

diff --git a/pysatSpaceWeather/tests/test_methods_ace.py b/pysatSpaceWeather/tests/test_methods_ace.py
@@ -65,7 +65,14 @@ class TestACESWEPAMMethods(object):
 
     def setup_method(self):
         """Create a clean testing setup."""
-        self.testInst = pysat.Instrument('pysat', 'testing', use_header=True)
+
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        inst_kwargs = dict()
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_kwargs['use_header'] = True
+
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_kwargs)
         self.testInst.load(date=self.testInst.inst_module._test_dates[''][''])
 
         self.omni_keys = ['sw_proton_dens_norm', 'sw_ion_temp_norm']

diff --git a/pysatSpaceWeather/tests/test_methods_f107.py b/pysatSpaceWeather/tests/test_methods_f107.py
@@ -140,7 +140,10 @@ def setup_method(self):
         self.combine_times = {"start": self.test_day - dt.timedelta(days=30),
                               "stop": self.test_day + dt.timedelta(days=3)}
         self.load_kwargs = {}
-        if Version(pysat.__version__) > Version('3.0.1'):
+
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             self.load_kwargs['use_header'] = True
 
         return

diff --git a/pysatSpaceWeather/tests/test_methods_general.py b/pysatSpaceWeather/tests/test_methods_general.py
@@ -20,7 +20,12 @@ class TestGeneralMethods(object):
 
     def setup_method(self):
         """Create a clean testing setup."""
-        self.testInst = pysat.Instrument('pysat', 'testing', use_header=True)
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        inst_kwargs = dict()
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_kwargs['use_header'] = True
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_kwargs)
         self.testInst.load(date=self.testInst.inst_module._test_dates[''][''])
         return
 

diff --git a/pysatSpaceWeather/tests/test_methods_kp.py b/pysatSpaceWeather/tests/test_methods_kp.py
@@ -25,13 +25,20 @@ def setup_method(self):
         """Create a clean testing setup."""
         self.test_function = kp_ap.initialize_kp_metadata
 
+        inst_dict = {'num_samples': 12}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_dict['use_header'] = True
+
         # Load a test instrument
-        self.testInst = pysat.Instrument('pysat', 'testing', num_samples=12,
-                                         use_header=True)
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_dict)
         test_time = pysat.instruments.pysat_testing._test_dates['']['']
 
         load_kwargs = {'date': test_time}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
         self.testInst.load(**load_kwargs)
@@ -122,13 +129,20 @@ def setup_method(self):
         """Create a clean testing setup."""
         self.test_function = kp_ap.initialize_ap_metadata
 
+        inst_dict = {'num_samples': 12}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_dict['use_header'] = True
+
         # Load a test instrument
-        self.testInst = pysat.Instrument('pysat', 'testing', num_samples=12,
-                                         use_header=True)
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_dict)
         test_time = pysat.instruments.pysat_testing._test_dates['']['']
 
         load_kwargs = {'date': test_time}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
         self.testInst.load(**load_kwargs)
@@ -170,13 +184,20 @@ def setup_method(self):
         """Create a clean testing setup."""
         self.test_function = kp_ap.initialize_bartel_metadata
 
+        inst_dict = {'num_samples': 12}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_dict['use_header'] = True
+
         # Load a test instrument
-        self.testInst = pysat.Instrument('pysat', 'testing', num_samples=12,
-                                         use_header=True)
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_dict)
         test_time = pysat.instruments.pysat_testing._test_dates['']['']
 
         load_kwargs = {'date': test_time}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
         self.testInst.load(**load_kwargs)
@@ -267,13 +288,20 @@ class TestSWKp(object):
 
     def setup_method(self):
         """Create a clean testing setup."""
+        inst_dict = {'num_samples': 12}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_dict['use_header'] = True
+
         # Load a test instrument
-        self.testInst = pysat.Instrument('pysat', 'testing', num_samples=12,
-                                         use_header=True)
+        self.testInst = pysat.Instrument('pysat', 'testing', **inst_dict)
         test_time = pysat.instruments.pysat_testing._test_dates['']['']
 
         load_kwargs = {'date': test_time}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
         self.testInst.load(**load_kwargs)
@@ -476,22 +504,23 @@ def setup_method(self):
 
         # Set combination testing input
         test_day = dt.datetime(2019, 3, 18)
-        self.combine = {"standard_inst": pysat.Instrument(inst_module=sw_kp,
-                                                          tag="def",
-                                                          update_files=True,
-                                                          use_header=True),
-                        "recent_inst": pysat.Instrument(inst_module=sw_kp,
-                                                        tag="recent",
-                                                        update_files=True,
-                                                        use_header=True),
-                        "forecast_inst":
-                        pysat.Instrument(inst_module=sw_kp, tag="forecast",
-                                         update_files=True, use_header=True),
+        idict = {'inst_module': sw_kp, 'update_files': True}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            idict['use_header'] = True
+
+        self.combine = {"standard_inst": pysat.Instrument(tag="def", **idict),
+                        "recent_inst": pysat.Instrument(tag="recent", **idict),
+                        "forecast_inst": pysat.Instrument(tag="forecast",
+                                                          **idict),
                         "start": test_day - dt.timedelta(days=30),
                         "stop": test_day + dt.timedelta(days=3),
                         "fill_val": -1}
         self.load_kwargs = {"date": test_day}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             self.load_kwargs['use_header'] = True
 
         return
@@ -662,12 +691,19 @@ class TestSWAp(object):
 
     def setup_method(self):
         """Create a clean testing setup."""
-        self.test_inst = pysat.Instrument('pysat', 'testing', num_samples=10,
-                                          use_header=True)
+        inst_dict = {'num_samples': 10}
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
+            inst_dict['use_header'] = True
+
+        self.test_inst = pysat.Instrument('pysat', 'testing', **inst_dict)
         test_time = pysat.instruments.pysat_testing._test_dates['']['']
 
         load_kwargs = {'date': test_time}
-        if Version(pysat.__version__) > Version('3.0.1'):
+        # TODO(#131): Remove version check after min version supported is 3.2.0
+        if all([Version(pysat.__version__) > Version('3.0.1'),
+                Version(pysat.__version__) < Version('3.2.0')]):
             load_kwargs['use_header'] = True
 
         self.test_inst.load(**load_kwargs)