seppy 0.1.19__py3-none-any.whl → 0.2.1__py3-none-any.whl

seppy/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.19'
-__version_tuple__ = version_tuple = (0, 1, 19)
+__version__ = version = '0.2.1'
+__version_tuple__ = version_tuple = (0, 2, 1)

seppy/loader/psp.py

@@ -199,8 +199,8 @@ def psp_isois_load(dataset, startdate, enddate, epilo_channel='F', epilo_thresho
         Name of PSP dataset:
             - 'PSP_ISOIS-EPIHI_L2-HET-RATES60'
             - 'PSP_ISOIS-EPIHI_L2-HET-RATES3600' (higher coverage than 'RATES60' before mid-2021)
-            - 'PSP_ISOIS-EPIHI_L2-LET1-RATES60' (not yet supported)
-            - 'PSP_ISOIS-EPIHI_L2-LET2-RATES60' (not yet supported)
+            - 'PSP_ISOIS-EPIHI_L2-LET1-RATES60'
+            - 'PSP_ISOIS-EPIHI_L2-LET2-RATES60'
             - 'PSP_ISOIS-EPILO_L2-PE'
             - 'PSP_ISOIS-EPILO_L2-IC'
     startdate, enddate : {datetime or str}
@@ -254,19 +254,20 @@ def psp_isois_load(dataset, startdate, enddate, epilo_channel='F', epilo_thresho
             df = data.to_dataframe()
             # df = read_cdf(downloaded_files[0])
 
-            # reduce data frame to only H_Flux, H_Uncertainty, Electron_Counts, and Electron_Rate.
-            # There is no Electron_Uncertainty, maybe one could use at least the Poission error from Electron_Counts for that.
-            # df = df.filter(like='H_Flux') + df.filter(like='H_Uncertainty') + df.filter(like='Electrons')
-            if dataset.split('-')[2].upper() == 'HET':
-                if dataset.split('-')[3] == 'RATES60':
-                    selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
-                if dataset.split('-')[3] == 'RATES3600':
-                    selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
-            if dataset.split('-')[2].upper() == 'LET1':
-                selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
-            if dataset.split('-')[2].upper() == 'LET2':
-                selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
-            df = df[df.columns[df.columns.str.startswith(tuple(selected_cols))]]
+            # # reduce data frame to only H_Flux, H_Uncertainty, Electron_Counts, and Electron_Rate.
+            # # There is no Electron_Uncertainty, maybe one could use at least the Poission error from Electron_Counts for that.
+            # # df = df.filter(like='H_Flux') + df.filter(like='H_Uncertainty') + df.filter(like='Electrons')
+            # if dataset.split('-')[2].upper() == 'HET':
+            #     if dataset.split('-')[3] == 'RATES60':
+            #         selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
+            #     if dataset.split('-')[3] == 'RATES3600':
+            #         selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
+            # if dataset.split('-')[2].upper() == 'LET1':
+            #     selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
+            # if dataset.split('-')[2].upper() == 'LET2':
+            #     selected_cols = ["A_H_Flux", "B_H_Flux", "A_H_Uncertainty", "B_H_Uncertainty", "A_Electrons", "B_Electrons"]
+            # df = df[df.columns[df.columns.str.startswith(tuple(selected_cols))]]
+            # raise Warning(f"{dataset} is not fully suppported, only proton and electron data will be processed!")
 
             cdf = cdflib.CDF(downloaded_files[0])
 
@@ -288,8 +289,6 @@ def psp_isois_load(dataset, startdate, enddate, epilo_channel='F', epilo_thresho
                              cdf['H_ENERGY_DELTAMINUS'],
                              "H_ENERGY_LABL":
                              cdf['H_ENERGY_LABL'],
-                             "H_FLUX_UNITS":
-                             cdf.varattsget('A_H_Flux')['UNITS'],
                              "Electrons_ENERGY":
                              cdf['Electrons_ENERGY'],
                              "Electrons_ENERGY_DELTAPLUS":
@@ -297,10 +296,17 @@ def psp_isois_load(dataset, startdate, enddate, epilo_channel='F', epilo_thresho
                              "Electrons_ENERGY_DELTAMINUS":
                              cdf['Electrons_ENERGY_DELTAMINUS'],
                              "Electrons_ENERGY_LABL":
-                             cdf['Electrons_ENERGY_LABL'],
-                             "Electrons_Rate_UNITS":
-                             cdf.varattsget('A_Electrons_Rate')['UNITS']
+                             cdf['Electrons_ENERGY_LABL']
                              }
+            try:
+                energies_dict["H_FLUX_UNITS"] = cdf.varattsget('A_H_Flux')['UNITS']
+                energies_dict["Electrons_Rate_UNITS"] = cdf.varattsget('A_Electrons_Rate')['UNITS']
+            except ValueError:
+                try:
+                    energies_dict["H_FLUX_UNITS"] = cdf.varattsget('C_H_Flux')['UNITS']
+                    energies_dict["Electrons_Rate_UNITS"] = cdf.varattsget('C_Electrons_Rate')['UNITS']
+                except ValueError:
+                    raise Warning(f"Can't obtain UNITS from metadata. Possibly an unsupported dataset is loaded!")
 
         # loading for EPILO
         if dataset.split('-')[1] == 'EPILO_L2':

seppy/loader/stereo.py

@@ -290,7 +290,7 @@ def _get_metadata(dataset, path_to_cdf):
     return metadata
 
 
-def stereo_load(instrument, startdate, enddate, spacecraft='ahead', mag_coord='RTN', sept_species='e', sept_viewing='sun', path=None, resample=None, pos_timestamp='center', max_conn=5):
+def stereo_load(instrument, startdate, enddate, spacecraft='ahead', mag_coord='RTN', sept_species='e', sept_viewing=None, path=None, resample=None, pos_timestamp='center', max_conn=5):
     """
     Downloads CDF files via SunPy/Fido from CDAWeb for HET, LET, MAG, and SEPT onboard STEREO
 
@@ -358,16 +358,19 @@ def stereo_load(instrument, startdate, enddate, spacecraft='ahead', mag_coord='R
         spacecraft='behind'
 
     if instrument.upper()=='SEPT':
-        df, channels_dict_df = stereo_sept_loader(startdate=startdate,
-                                                  enddate=enddate,
-                                                  spacecraft=spacecraft,
-                                                  species=sept_species,
-                                                  viewing=sept_viewing,
-                                                  resample=resample,
-                                                  path=path,
-                                                  all_columns=False,
-                                                  pos_timestamp=pos_timestamp)
-        return df, channels_dict_df
+        if not sept_viewing:
+            raise Exception("STEREO/SEPT loading requires a defined 'sept_viewing'!")
+        else:
+            df, channels_dict_df = stereo_sept_loader(startdate=startdate,
+                                                      enddate=enddate,
+                                                      spacecraft=spacecraft,
+                                                      species=sept_species,
+                                                      viewing=sept_viewing,
+                                                      resample=resample,
+                                                      path=path,
+                                                      all_columns=False,
+                                                      pos_timestamp=pos_timestamp)
+            return df, channels_dict_df
     else:
         # define spacecraft string
         sc = 'ST' + spacecraft.upper()[0]

seppy/tests/test_loader.py

@@ -13,7 +13,7 @@ def test_psp_load_online():
     df, meta = psp_isois_load(dataset='PSP_ISOIS-EPIHI_L2-HET-RATES60', startdate="2021/05/31",
                               enddate="2021/06/01", path=None, resample="1min")
     assert isinstance(df, pd.DataFrame)
-    assert df.shape == (48, 136)
+    assert df.shape == (48, 1304)
     assert meta['H_ENERGY_LABL'].flatten()[0] == '  6.7 -   8.0 MeV'
     # Check that fillvals are replaced by NaN
     assert np.sum(np.isnan(df['B_H_Uncertainty_14'])) == 48
@@ -120,7 +120,7 @@ def test_stereo_het_load_offline():
 
 def test_stereo_sept_load_online():
     df, meta = stereo_load(instrument="SEPT", startdate="2006/11/14", enddate="2006/11/14",
-                           path=None, resample="1min", pos_timestamp='center')
+                           path=None, resample="1min", pos_timestamp='center', sept_viewing='north')
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (371, 30)
     assert meta.ch_strings[meta.index==2].values[0] == '45.0-55.0 keV'
@@ -133,7 +133,7 @@ def test_stereo_sept_load_offline():
     fullpath = get_pkg_data_filename('data/test/sept_ahead_ele_sun_2006_318_1min_l2_v03.dat', package='seppy')
     path = Path(fullpath).parent.as_posix()
     df, meta = stereo_load(instrument="SEPT", startdate="2006/11/14", enddate="2006/11/14",
-                           path=path, resample="1min", pos_timestamp=None)
+                           path=path, resample="1min", pos_timestamp=None, sept_viewing='sun')
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (371, 30)
     assert meta.ch_strings[meta.index==2].values[0] == '45.0-55.0 keV'

seppy/tests/test_tools.py

@@ -170,7 +170,7 @@ def test_onset_spectrum_tsa_PSP_ISOIS_EPIHI_online():
     lpath = f"{os.getcwd()}/data/"
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     # viewing "A", single channel, electrons
-    Event1 = Event(spacecraft='PSP', sensor='isois-epihi', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)
+    Event1 = Event(spacecraft='PSP', sensor='isois-epihi', viewing='A', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)
     print(Event1.print_energies())
     flux, onset_stats, onset_found, peak_flux, peak_time, fig, bg_mean = Event1.find_onset(viewing='A', background_range=background_range, channels=4, resample_period="5min", yscale='log', cusum_window=30)
     assert isinstance(flux, pd.Series)
@@ -181,7 +181,7 @@ def test_onset_spectrum_tsa_PSP_ISOIS_EPIHI_online():
     assert peak_time.isoformat().split('.')[0] == '2021-10-28T16:06:59'
     assert fig.get_axes()[0].get_title() == 'PSP/ISOIS-EPIHI 0.8 - 1.0 MeV electrons\n5min averaging, viewing: A'
     # viewing "B", combined channel, protons
-    Event1 = Event(spacecraft='PSP', sensor='isois-epihi', data_level='l2', species='protons', start_date=startdate, end_date=enddate, data_path=lpath)
+    Event1 = Event(spacecraft='PSP', sensor='isois-epihi', viewing='B', data_level='l2', species='protons', start_date=startdate, end_date=enddate, data_path=lpath)
     print(Event1.print_energies())
     flux, onset_stats, onset_found, peak_flux, peak_time, fig, bg_mean = Event1.find_onset(viewing='B', background_range=background_range, channels=[1, 5], resample_period="5min", yscale='log', cusum_window=30)
     assert isinstance(flux, pd.Series)
@@ -206,7 +206,7 @@ def test_onset_spectrum_tsa_PSP_ISOIS_EPILO_e_online():
     startdate = datetime.date(2021, 10, 28)
     enddate = datetime.date(2021, 10, 29)
     lpath = f"{os.getcwd()}/data/"
-    Event1 = Event(spacecraft='PSP', sensor='isois-epilo', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)
+    Event1 = Event(spacecraft='PSP', sensor='isois-epilo', viewing='7', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)
     print(Event1.print_energies())
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     # viewing "7", single channel
@@ -242,7 +242,7 @@ def test_onset_spectrum_tsa_Wind_3DP_p_online():
     startdate = datetime.date(2021, 10, 28)
     enddate = datetime.date(2021, 10, 29)
     lpath = f"{os.getcwd()}/data/"
-    Event1 = Event(spacecraft='Wind', sensor='3DP', data_level='l2', species='protons', start_date=startdate, end_date=enddate, data_path=lpath)
+    Event1 = Event(spacecraft='Wind', sensor='3DP', data_level='l2', viewing="Sector 3", species='protons', start_date=startdate, end_date=enddate, data_path=lpath)
     print(Event1.print_energies())
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     # viewng "sector 3"
@@ -279,7 +279,7 @@ def test_onset_spectrum_tsa_Wind_3DP_e_online():
     startdate = datetime.date(2021, 10, 28)
     enddate = datetime.date(2021, 10, 29)
     lpath = f"{os.getcwd()}/data/"
-    Event1 = Event(spacecraft='Wind', sensor='3DP', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)  # TODO: radio_spacecraft=('wind', 'WIND')
+    Event1 = Event(spacecraft='Wind', sensor='3DP', viewing="Sector 3", data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath)  # TODO: radio_spacecraft=('wind', 'WIND')
     print(Event1.print_energies())
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     #
@@ -370,7 +370,7 @@ def test_onset_spectrum_tsa_STEREOA_SEPT_p_online():
     startdate = datetime.date(2021, 10, 28)
     enddate = datetime.date(2021, 10, 28)
     lpath = f"{os.getcwd()}/data/"
-    Event1 = Event(spacecraft='STEREO-A', sensor='SEPT', data_level='l2', species='ions', start_date=startdate, end_date=enddate, data_path=lpath)
+    Event1 = Event(spacecraft='STEREO-A', sensor='SEPT', viewing="north", data_level='l2', species='ions', start_date=startdate, end_date=enddate, data_path=lpath)
     print(Event1.print_energies())
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     flux, onset_stats, onset_found, peak_flux, peak_time, fig, bg_mean = Event1.find_onset(viewing='north', background_range=background_range, channels=[5, 8], resample_period="5min", yscale='log', cusum_window=30)
@@ -384,12 +384,12 @@ def test_onset_spectrum_tsa_STEREOA_SEPT_p_online():
     assert fig.get_axes()[0].get_title() == 'STA/SEPT 110-174.6 keV protons\n5min averaging, viewing: NORTH'
 
     # test dynamic spectrum:
-    Event1.dynamic_spectrum(view=None)
-    assert Event1.fig.get_axes()[0].get_title() == 'STA/SEPT protons, 2021-10-28'
+    Event1.dynamic_spectrum(view="north")
+    assert Event1.fig.get_axes()[0].get_title() == 'STA/SEPT (north) protons, 2021-10-28'
 
     # test tsa plot:
     plt.close('all')  # in order to pick the right figure, make sure all previous are closed
-    Event1.tsa_plot(None, selection=None, resample=None)
+    Event1.tsa_plot(view="north", selection=None, resample=None)
     assert plt.figure(1).get_axes()[0].get_title() == 'STEREO-A SEPT, protons'
 
 
@@ -397,7 +397,7 @@ def test_onset_spectrum_tsa_STEREOA_SEPT_e_online():
     startdate = datetime.date(2021, 10, 28)
     enddate = datetime.date(2021, 10, 28)
     lpath = f"{os.getcwd()}/data/"
-    Event1 = Event(spacecraft='STEREO-A', sensor='SEPT', data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath, radio_spacecraft=('ahead', 'STEREO-A'))
+    Event1 = Event(spacecraft='STEREO-A', sensor='SEPT', viewing="asun", data_level='l2', species='electrons', start_date=startdate, end_date=enddate, data_path=lpath, radio_spacecraft=('ahead', 'STEREO-A'))
     print(Event1.print_energies())
     background_range = (datetime.datetime(2021, 10, 28, 10, 0, 0), datetime.datetime(2021, 10, 28, 12, 0, 0))
     flux, onset_stats, onset_found, peak_flux, peak_time, fig, bg_mean = Event1.find_onset(viewing='asun', background_range=background_range, channels=[8], resample_period="5min", yscale='log', cusum_window=30)
@@ -411,12 +411,12 @@ def test_onset_spectrum_tsa_STEREOA_SEPT_e_online():
     assert fig.get_axes()[0].get_title() == 'STA/SEPT 125-145 keV electrons\n5min averaging, viewing: ASUN'
 
     # test dynamic spectrum:
-    Event1.dynamic_spectrum(view=None)
-    assert Event1.fig.get_axes()[0].get_title() == 'Radio & Dynamic Spectrum, STA/SEPT electrons, 2021-10-28'
+    Event1.dynamic_spectrum(view="asun")
+    assert Event1.fig.get_axes()[0].get_title() == 'Radio & Dynamic Spectrum, STA/SEPT (asun) electrons, 2021-10-28'
 
     # test tsa plot:
     plt.close('all')  # in order to pick the right figure, make sure all previous are closed
-    Event1.tsa_plot(None, selection=None, resample=None)
+    Event1.tsa_plot(view="asun", selection=None, resample=None)
     assert plt.figure(1).get_axes()[0].get_title() == 'STEREO-A SEPT, electrons'
 
 
@@ -448,7 +448,6 @@ def test_onset_spectrum_tsa_SOHO_EPHIN_online():
     Event1.dynamic_spectrum(view=None)
     assert Event1.fig.get_axes()[0].get_title() == 'SOHO/EPHIN electrons, 2021-10-28'
 
-
     # test tsa plot:
     plt.close('all')  # in order to pick the right figure, make sure all previous are closed
     Event1.tsa_plot(None, selection=(0, 4, 1), resample='5min')

seppy/tools/__init__.py

@@ -32,6 +32,16 @@ warnings.filterwarnings(action="ignore",
                         decreasing. This may lead to incorrectly calculated cell edges, in which case, please supply explicit cell edges to pcolormesh.",
                         category=UserWarning)
 
+STEREO_SEPT_VIEWINGS = ("sun", "asun", "north", "south")
+WIND_3DP_VIEWINGS = ("omnidirectional", '0', '1', '2', '3', '4', '5', '6', '7')
+SOLO_EPT_VIEWINGS = ("sun", "asun", "north", "south")
+SOLO_HET_VIEWINGS = ("sun", "asun", "north", "south")
+SOLO_STEP_VIEWINGS = ("Pixel averaged", "Pixel 1", "Pixel 2", "Pixel 3", "Pixel 4", "Pixel 5", "Pixel 6",
+                      "Pixel 7", "Pixel 8", "Pixel 9", "Pixel 10", "Pixel 11", "Pixel 12", "Pixel 13",
+                      "Pixel 14", "Pixel 15")
+PSP_EPILO_VIEWINGS = ('3', '7')
+PSP_EPIHI_VIEWINGS = ('A', 'B')
+
 
 class Event:
 
@@ -63,7 +73,9 @@ class Event:
         self.data_path = data_path + os.sep
         self.threshold = threshold
         self.radio_spacecraft = radio_spacecraft  # this is a 2-tuple, e.g., ("ahead", "STEREO-A")
-        self.viewing = viewing
+
+        # Sets the self.viewing to the given viewing
+        self.update_viewing(viewing=viewing)
 
         self.radio_files = None
 
@@ -146,17 +158,52 @@ class Event:
                        }
 
     def update_viewing(self, viewing):
+
+        invalid_viewing_msg = f"{viewing} is an invalid viewing direction for {self.spacecraft}/{self.sensor}!"
+
         if self.spacecraft != "wind":
+
+            # Validate viewing here. It may be nonsensical and that affects choose_data() and print_energies().
+            if self.spacecraft in ("sta", "stb"):
+                if self.sensor == "sept" and viewing not in STEREO_SEPT_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+                if self.sensor == "het" and viewing is not None:
+                    raise ValueError(invalid_viewing_msg)
+
+            if self.spacecraft == "solo":
+                if self.sensor == "step" and viewing not in SOLO_STEP_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+                if self.sensor == "ept" and viewing not in SOLO_EPT_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+                if self.sensor == "het" and viewing not in SOLO_HET_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+
+            if self.spacecraft == "psp":
+                if self.sensor == "isois-epilo" and viewing not in PSP_EPILO_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+                if self.sensor == "isois-epihi" and viewing not in PSP_EPIHI_VIEWINGS:
+                    raise ValueError(invalid_viewing_msg)
+
+            if self.spacecraft == "soho":
+                if viewing is not None:
+                    raise ValueError(invalid_viewing_msg)
+
+            # Finally set validated viewing
             self.viewing = viewing
+
         else:
-            # Wind/3DP viewing directions are omnidirectional, section 0, section 1... section n.
+            # Wind/3DP viewing directions are omnidirectional, section 0, section 1... section 7.
             # This catches the number or the word if omnidirectional
             try:
-                self.viewing = viewing.split(" ")[-1]
-
-            # AttributeError is cause by initializing Event with spacecraft='Wind' and viewing=None
+                sector_direction = viewing.split(" ")[-1]
+            # AttributeError is caused by calling None.split()
             except AttributeError:
-                self.viewing = '0'  # A placeholder viewing that should not cause any trouble
+                raise ValueError(invalid_viewing_msg)
+
+            if sector_direction not in WIND_3DP_VIEWINGS:
+                raise ValueError(invalid_viewing_msg)
+
+            self.viewing = sector_direction
 
     # I suggest we at some point erase the arguments ´spacecraft´ and ´threshold´ due to them not being used.
     # `viewing` and `autodownload` are actually the only necessary input variables for this function, the rest
@@ -174,7 +221,7 @@ class Event:
                                             enddate=self.end_date,
                                             path=self.data_path,
                                             autodownload=autodownload)
-                # self.update_viewing(viewing) Why is viewing updated here?
+
                 return df_i, df_e, meta
 
             elif self.sensor == "step":
@@ -186,7 +233,6 @@ class Event:
                                     path=self.data_path,
                                     autodownload=autodownload)
 
-                # self.update_viewing(viewing) Why is viewing updated here?
                 return df, meta
 
         if self.spacecraft[:2].lower() == 'st':
@@ -204,7 +250,6 @@ class Event:
                                                            path=self.data_path)
                     df_e, channels_dict_df_e = [], []
 
-                    self.update_viewing(viewing)
                     return df_i, df_e, channels_dict_df_i, channels_dict_df_e
 
                 if self.species == "e":
@@ -221,7 +266,6 @@ class Event:
 
                     df_i, channels_dict_df_i = [], []
 
-                    self.update_viewing(viewing)
                     return df_i, df_e, channels_dict_df_i, channels_dict_df_e
 
             if self.sensor == 'het':
@@ -233,7 +277,6 @@ class Event:
                                        pos_timestamp="center",
                                        path=self.data_path)
 
-                self.update_viewing(viewing)
                 return df, meta
 
         if self.spacecraft.lower() == 'soho':
@@ -245,7 +288,6 @@ class Event:
                                      resample=None,
                                      pos_timestamp="center")
 
-                self.update_viewing(viewing)
                 return df, meta
 
             if self.sensor == 'ephin':
@@ -256,7 +298,6 @@ class Event:
                                      resample=None,
                                      pos_timestamp="center")
 
-                self.update_viewing(viewing)
                 return df, meta
 
             if self.sensor in ("ephin-5", "ephin-15"):
@@ -277,7 +318,6 @@ class Event:
                 # - add resample_df here?
                 # - add pos_timestamp here
 
-                self.update_viewing(viewing)
                 return df, meta
 
         if self.spacecraft.lower() == 'wind':
@@ -320,7 +360,6 @@ class Event:
                                                       path=self.data_path,
                                                       threshold=self.threshold)
 
-                self.update_viewing(viewing)
                 return df_omni_i, df_omni_e, df_i, df_e, meta_i, meta_e
 
         if self.spacecraft.lower() == 'psp':
@@ -331,7 +370,6 @@ class Event:
                                           path=self.data_path,
                                           resample=None)
 
-                self.update_viewing(viewing)
                 return df, meta
             if self.sensor.lower() == 'isois-epilo':
                 df, meta = psp_isois_load(dataset='PSP_ISOIS-EPILO_L2-PE',
@@ -342,7 +380,6 @@ class Event:
                                           epilo_channel='F',
                                           epilo_threshold=self.threshold)
 
-                self.update_viewing(viewing)
                 return df, meta
 
         if self.spacecraft.lower() == 'bepi':
@@ -2216,7 +2253,7 @@ class Event:
                 line.set_xdata(line.get_xdata() - pd.Timedelta(seconds=timedelta_sec))
 
             # Update the path label artist
-            text.set_text(f"R={radial_distance_value:.2f} AU\nL = {np.round(slider.value,2)} AU")
+            text.set_text(f"R={radial_distance_value:.2f} AU\nL = {np.round(slider.value, 2)} AU")
 
             # Effectively this refreshes the figure
             fig.canvas.draw_idle()

seppy/util/__init__.py

@@ -1,5 +1,6 @@
 
 import datetime
+import psutil
 import warnings
 
 import astropy.constants as const
@@ -429,3 +430,14 @@ def intensity2vsd(species, kinetic_energy, intensity):
         p = energy2momentum(species, kinetic_energy)
         f = intensity / (p**2) * mass_dict[species]**3
         return f.to(u.s**3/(u.sr*u.cm**6))
+
+
+def jupyterhub_data_path(path_org, path_hub='/home/jovyan/data'):
+    """
+    Checks if Notebook is run within SOLER/SERPENTINE JupyterHub. Returns the path of a common data folder if yes, and the original path if not.
+    """
+    if (psutil.Process().parent().name() == 'jupyterhub-sing') and all(x in psutil.Process().parent().environ()['PYTHONPATH'] for x in ['/home/jovyan/serpentine/', '/home/jovyan/soler/sep_tools/']):
+        print(f"JupyterHub detected. Adjusting data path to {path_hub}")
+        return path_hub
+    else:
+        return path_org

seppy/version.py

@@ -14,4 +14,4 @@ except Exception:
     )
     del warnings
 
-    version = '0.1.19'
+    version = '0.2.1'

{seppy-0.1.19.dist-info → seppy-0.2.1.dist-info}/METADATA

@@ -1,37 +1,11 @@
 Metadata-Version: 2.4
 Name: seppy
-Version: 0.1.19
+Version: 0.2.1
 Summary: SEPpy
 Author-email: Jan Gieseler <jan.gieseler@utu.fi>
-License: Copyright (c) 2022, Jan Gieseler
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without modification,
-        are permitted provided that the following conditions are met:
-        
-        * Redistributions of source code must retain the above copyright notice, this
-          list of conditions and the following disclaimer.
-        * Redistributions in binary form must reproduce the above copyright notice, this
-          list of conditions and the following disclaimer in the documentation and/or
-          other materials provided with the distribution.
-        * Neither the name of SEPpy nor the names of its contributors may be
-          used to endorse or promote products derived from this software without
-          specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
+License-Expression: BSD-3-Clause
 Project-URL: repository, https://github.com/serpentine-h2020/SEPpy
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python

{seppy-0.1.19.dist-info → seppy-0.2.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 seppy/__init__.py,sha256=hk6JGncma6FHC5b8g5ZelvpsF1Jo-3Pz_3MneUcNWMg,156
-seppy/_version.py,sha256=-W-i-_6L24OJ73VmeltYID1xpUrwRUNYxZXkfU86ff0,513
-seppy/version.py,sha256=W_Fwi9aljZivAB9ddpA8HGKIrlvM1KDHRMxWdOz5ANo,532
+seppy/_version.py,sha256=UoNvMtd4wCG76RwoSpNCUtaFyTwakGcZolfjXzNVSMY,511
+seppy/version.py,sha256=s9jrGGO9QQFBgDmuFff6kUkpz-CIO0Sx5J3q0nn2YLU,531
 seppy/data/test/20230719_side0.csv,sha256=0htTQcdQydRc92bkO26lxK8tDRSeN6uov13VfsqmUFQ,72368
 seppy/data/test/20230719_side1.csv,sha256=iHCfHmOIltJatncWpns_zq3ym_-2yRu0twmDvQDbmJw,72368
 seppy/data/test/20230719_side2.csv,sha256=eYyEQX5fNDO4E57KwKN3bHs6u5-lHaAhIHt-3f20Urg,72368
@@ -11,22 +11,22 @@ seppy/data/test/solo_l2_mag-rtn-normal-1-minute_20210712_v01.cdf,sha256=Tc_-3YQM
 seppy/data/test/sta_l1_het_20211028_v01.cdf,sha256=429TIPXSQI5heQVNqyRYLF7HUDZPByzk-xYf9IzSJ0U,215082
 seppy/data/test/wi_sfsp_3dp_00000000_v01.cdf,sha256=ifAM0FiB2tepHmlpsqbotJMyQqSB3bwpPcKD6VhukFA,30939
 seppy/data/test/wi_sfsp_3dp_20200213_v01.cdf,sha256=UiKcBPcWZkh3KIBigoZubTJ3Fw90E8p7XhbA9uW6VWk,67008
-seppy/loader/psp.py,sha256=dsFWF6OPPHSFqqiZwEL7_Y9pDQ6xUgg5biIGB1vsjh4,31546
+seppy/loader/psp.py,sha256=cOunehm9gvUl9hVF2CgAqje1aA6r4HGhvEnHkvddFyU,32005
 seppy/loader/soho.py,sha256=e6SzUD_WxUiaAMlWQcTGVvdER4Wv9rI-PtCCEoUHVRw,20290
 seppy/loader/solo.py,sha256=Nst2ZJU2yH5NHsB6M_69ryVfzt978hbmqhxaHZJREVg,3054
-seppy/loader/stereo.py,sha256=C0NM3xxzYS27Z6MbYJLRNM_sxw-5Ypx7QS2aoWt4Bco,24655
+seppy/loader/stereo.py,sha256=dkfxPiwCFmn9UfD0QYoIBW6rx6-faXjjk8IU2WMN-j4,24823
 seppy/loader/wind.py,sha256=LC-pbjbhpgTowsR20mflk35ebb2lOZClMyJ94aZ-ecQ,18987
 seppy/tests/__init__.py,sha256=W9JYSayCPwoTmtRpjYCkKnnbPQqpf26ANqXe52YASmk,44
-seppy/tests/test_loader.py,sha256=0C9OmjQk9Br9kLzVdrMtDWJH-N4tD6AfiQIiQSDrc1k,8211
+seppy/tests/test_loader.py,sha256=OZc4sKn2OZcCrmu5awMB_nWdWkbuFoAonD5Amlaxk4g,8254
 seppy/tests/test_time_shift_analysis.ipynb,sha256=4DIKqqRI_AdburzP9RnMwdOAvZovpgON2TJscDABIco,7904
-seppy/tests/test_tools.py,sha256=LQPekw-ddse88OYu-LWChFcJPT2SwGS7uEG1tKRLVok,31539
+seppy/tests/test_tools.py,sha256=qSTAtaZTEw_oz32BsSzYX5BFNowJooWX6p-QEkOboiU,31685
 seppy/tests/tsa_org.png,sha256=80xrGx1unP1iXGLhPsKHHqMLrg2qhivsGh532hBVCqM,138501
-seppy/tools/__init__.py,sha256=nX_GL22ej9XLP6vHkKK_Ste8DtvVkusMEwHbO_wxvvQ,116011
+seppy/tools/__init__.py,sha256=GwxGektqXHmqbuFCAW66XreGOp0PJImqujN0swlBmKE,117677
 seppy/tools/swaves.py,sha256=OcohPXLko0ik9FLyYMVkYxI75W4XzOKvQ2Ylnwi-wlQ,3139
 seppy/tools/widgets.py,sha256=atQj9vvus0UgrUV6vlPcTdjpaidnERUevOp6FUmGLSI,6820
-seppy/util/__init__.py,sha256=RMMeH37L75wwQPHb_-_-2Rk7lzlDtBC2K6lkWKtxAMg,15253
-seppy-0.1.19.dist-info/licenses/LICENSE.rst,sha256=O5RzTapB1HKcaagHaoNKHBvjkzU6Kh1Ax6HZ_9Q4-kI,1520
-seppy-0.1.19.dist-info/METADATA,sha256=XHzp0Yfd0vzAuFfsySxyz7rXSo96fTv2ldRfuY75mHc,6372
-seppy-0.1.19.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-seppy-0.1.19.dist-info/top_level.txt,sha256=G2Op1GREPmbCX81isNhYY_7ZZyLWLIm-MJC04J4Fgc4,6
-seppy-0.1.19.dist-info/RECORD,,
+seppy/util/__init__.py,sha256=49gq3JkFcpZw65HPNslUnMjJ1wdVtJc-bbymPhb78I4,15826
+seppy-0.2.1.dist-info/licenses/LICENSE.rst,sha256=O5RzTapB1HKcaagHaoNKHBvjkzU6Kh1Ax6HZ_9Q4-kI,1520
+seppy-0.2.1.dist-info/METADATA,sha256=Lw_qh2vBRO2Qt1UdwyvDofJNwUudbCcrwzpwO0nLFJc,4670
+seppy-0.2.1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+seppy-0.2.1.dist-info/top_level.txt,sha256=G2Op1GREPmbCX81isNhYY_7ZZyLWLIm-MJC04J4Fgc4,6
+seppy-0.2.1.dist-info/RECORD,,

{seppy-0.1.19.dist-info → seppy-0.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any