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

seppy/__init__.py

@@ -1,7 +1,4 @@
-# Licensed under a 3-clause BSD style license - see LICENSE.rst
 
-from pkg_resources import get_distribution, DistributionNotFound
-try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    pass  # package is not installed
+from .version import version as __version__
+
+# __all__ = []  # defines which functions, variables etc. will be loaded when running "from pyonset import *"

seppy/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.19'
+__version_tuple__ = version_tuple = (0, 1, 19)

seppy/loader/psp.py

@@ -386,7 +386,7 @@ def calc_av_en_flux_PSP_EPIHI(df, energies, en_channel, species, instrument, vie
     df : pd.DataFrame DataFrame containing HET data
         DataFrame containing PSP data
     energies : dict
-        Energy dict returned from psp_loader
+        Energy dict returned from psp_load
     en_channel : int or list
         energy channel number(s) to be used
     species : string
@@ -410,8 +410,8 @@ def calc_av_en_flux_PSP_EPIHI(df, energies, en_channel, species, instrument, vie
             flux_key = 'H_Flux'
     en_str = energies[f'{species_str}_ENERGY_LABL']
     if type(en_channel) == list:
-        energy_low = en_str[en_channel[0]][0].split('-')[0]
-        energy_up = en_str[en_channel[-1]][0].split('-')[-1]
+        energy_low = en_str[en_channel[0]].flat[0].split('-')[0]
+        energy_up = en_str[en_channel[-1]].flat[0].split('-')[-1]
         en_channel_string = energy_low + '-' + energy_up
 
         DE = energies[f'{species_str}_ENERGY_DELTAPLUS']+energies[f'{species_str}_ENERGY_DELTAMINUS']
@@ -435,7 +435,7 @@ def calc_av_en_flux_PSP_EPIHI(df, energies, en_channel, species, instrument, vie
             flux_out = pd.DataFrame({'flux': df[f'{viewing.upper()}_{flux_key}_{en_channel}']}, index=df.index)
     else:
         flux_out = pd.DataFrame({'flux': df[f'{viewing.upper()}_{flux_key}_{en_channel}']}, index=df.index)
-        en_channel_string = en_str[en_channel][0]
+        en_channel_string = en_str[en_channel].flat[0]
     # replace multiple whitespaces with single ones
     en_channel_string = ' '.join(en_channel_string.split())
     return flux_out, en_channel_string
@@ -453,7 +453,7 @@ def calc_av_en_flux_PSP_EPILO(df, en_dict, en_channel, species, mode, chan, view
     df : pd.DataFrame DataFrame containing HET data
         DataFrame containing PSP data
     energies : dict
-        Energy dict returned from psp_loader
+        Energy dict returned from psp_load
     en_channel : int or list
         energy channel number(s) to be used
     species : string

seppy/loader/soho.py

@@ -39,13 +39,13 @@ def _get_metadata(dataset, path_to_cdf):
         if dataset=='SOHO_ERNE-LED_L2-1MIN':
             alpha = 'A'
             m = 'L'
-        metadata = {'He_E_label': cdf.varget('He_E_label')[0],
+        metadata = {'He_E_label': cdf.varget('He_E_label').flatten(),
                     'He_energy': cdf.varget('He_energy'),
                     'He_energy_delta': cdf.varget('He_energy_delta'),
                     f'{alpha}{m}_LABL': cdf.varattsget(f'{alpha}{m}')['LABLAXIS'],
                     f'{alpha}{m}_UNITS': cdf.varattsget(f'{alpha}{m}')['UNITS'],
                     f'{alpha}{m}_FILLVAL': cdf.varattsget(f'{alpha}{m}')['FILLVAL'],
-                    'P_E_label': cdf.varget('P_E_label')[0],
+                    'P_E_label': cdf.varget('P_E_label').flatten(),
                     'P_energy': cdf.varget('P_energy'),
                     'P_energy_delta': cdf.varget('P_energy_delta'),
                     f'P{m}_LABL': cdf.varattsget(f'P{m}')['LABLAXIS'],
@@ -53,14 +53,14 @@ def _get_metadata(dataset, path_to_cdf):
                     f'P{m}_FILLVAL': cdf.varattsget(f'P{m}')['FILLVAL'],
                     }
 
-        channels_dict_df_He = pd.DataFrame(cdf.varget('He_E_label')[0], columns=['ch_strings'])
+        channels_dict_df_He = pd.DataFrame(cdf.varget('He_E_label').flatten(), columns=['ch_strings'])
         channels_dict_df_He['lower_E'] = cdf.varget("He_energy")-cdf.varget("He_energy_delta")
         channels_dict_df_He['upper_E'] = cdf.varget("He_energy")+cdf.varget("He_energy_delta")
         channels_dict_df_He['DE'] = cdf.varget("He_energy_delta")
         # channels_dict_df_He['mean_E'] = np.sqrt(channels_dict_df_He['upper_E'] * channels_dict_df_He['lower_E'])
         channels_dict_df_He['mean_E'] = cdf.varget("He_energy")
 
-        channels_dict_df_p = pd.DataFrame(cdf.varget('P_E_label')[0], columns=['ch_strings'])
+        channels_dict_df_p = pd.DataFrame(cdf.varget('P_E_label').flatten(), columns=['ch_strings'])
         channels_dict_df_p['lower_E'] = cdf.varget("P_energy")-cdf.varget("P_energy_delta")
         channels_dict_df_p['upper_E'] = cdf.varget("P_energy")+cdf.varget("P_energy_delta")
         channels_dict_df_p['DE'] = cdf.varget("P_energy_delta")

seppy/loader/stereo.py

@@ -504,6 +504,8 @@ def calc_av_en_flux_HET(df, channels_dict_df, avg_channels, species):
     avg_channels : list of int, optional
         averaging channels m to n if [m, n] is provided (both integers), by default None
     """
+    if type(avg_channels) is int:
+        avg_channels = [avg_channels]
     # calculation of total delta-E for averaging multiple channels:
     if len(avg_channels) > 1:
         DE_total = channels_dict_df.loc[avg_channels[0]:avg_channels[-1]]['DE'].sum()

seppy/loader/wind.py

@@ -34,7 +34,7 @@ def _download_metafile(dataset, path=None):
         downloaded_file = pooch.retrieve(url=url, known_hash=None, fname=fname, path=path, progressbar=True)
     except ModuleNotFoundError:
         downloaded_file = pooch.retrieve(url=url, known_hash=None, fname=fname, path=path, progressbar=False)
-    print('')
+    #
     return downloaded_file
 
 

seppy/tests/__init__.py

@@ -1,4 +1,3 @@
-# Licensed under a 3-clause BSD style license - see LICENSE.rst
 """
 This module contains package tests.
 """

seppy/tests/test_loader.py

@@ -14,7 +14,7 @@ def test_psp_load_online():
                               enddate="2021/06/01", path=None, resample="1min")
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (48, 136)
-    assert meta['H_ENERGY_LABL'][0][0] == '  6.7 -   8.0 MeV'
+    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
     #
@@ -71,6 +71,15 @@ def test_soho_ephin_load_offline():
     assert np.sum(np.isnan(df['E1300'])) == 444
 
 
+def test_soho_erne_load_online():
+    df, meta = soho_load(dataset='SOHO_ERNE-HED_L2-1MIN', startdate="2021/04/16", enddate="2021/04/17",
+                         path=None, resample="1min", pos_timestamp='center')
+    assert isinstance(df, pd.DataFrame)
+    assert df.shape == (1145, 41)
+    assert meta['channels_dict_df_p']['ch_strings'].iloc[9] == '100 - 130 MeV'
+    assert df['PHC_9'].sum() == 1295.0
+
+
 def test_solo_mag_load_online():
     df = mag_load("2021/07/12", "2021/07/13", level='l2', data_type='normal-1-minute', frame='rtn', path=None)
     assert isinstance(df, pd.DataFrame)
@@ -93,7 +102,7 @@ def test_stereo_het_load_online():
                            path=None, resample="1min", pos_timestamp='center')
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (1440, 28)
-    assert meta['Proton_Bins_Text'][0][0] == '13.6 - 15.1 MeV '
+    assert meta['Proton_Bins_Text'].flatten()[0] == '13.6 - 15.1 MeV '
     assert np.sum(np.isnan(df['Electron_Flux_0'])) == 0
 
 
@@ -105,7 +114,7 @@ def test_stereo_het_load_offline():
                            path=path, resample="1min", pos_timestamp=None)
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (1440, 28)
-    assert meta['Proton_Bins_Text'][0][0] == '13.6 - 15.1 MeV '
+    assert meta['Proton_Bins_Text'].flatten()[0] == '13.6 - 15.1 MeV '
     assert np.sum(np.isnan(df['Electron_Flux_0'])) == 0
 
 
@@ -134,16 +143,16 @@ def test_stereo_sept_load_offline():
 
 def test_wind3dp_load_online():
     df, meta = wind3dp_load(dataset="WI_SFPD_3DP",
-                            startdate="2021/04/16",
-                            enddate="2021/04/18",
+                            startdate="2021/04/15",
+                            enddate="2021/04/17",
                             resample='1min',
                             multi_index=True,
                             path=None)
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (2880, 76)
-    assert meta['FLUX_LABELS'][0][0] == 'ElecNoFlux_Ch1_Often~27keV '
+    assert meta['FLUX_LABELS'].flatten()[0] == 'ElecNoFlux_Ch1_Often~27keV '
     # Check that fillvals are replaced by NaN
-    assert np.sum(np.isnan(df['FLUX_E0', 'FLUX_E0_P0'])) == 169
+    assert np.sum(np.isnan(df['FLUX_E0', 'FLUX_E0_P0'])) == 129
 
 
 def test_wind3dp_load_offline():
@@ -158,6 +167,6 @@ def test_wind3dp_load_offline():
                             path=path)
     assert isinstance(df, pd.DataFrame)
     assert df.shape == (897, 15)
-    assert meta['FLUX_LABELS'][0][0] == 'ElecNoFlux_Ch1_Often~27keV '
+    assert meta['FLUX_LABELS'].flatten()[0] == 'ElecNoFlux_Ch1_Often~27keV '
     # Check that fillvals are replaced by NaN
     assert np.sum(np.isnan(df['FLUX_0'])) == 352

seppy/tests/test_time_shift_analysis.ipynb

@@ -0,0 +1,286 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "dff1322b",
+   "metadata": {},
+   "source": [
+    "#  Visual time shift analysis\n",
+    "\n",
+    "<div class=\"alert alert-block alert-success\">\n",
+    "<b>Please refer to the following paper for more information and cite it if you use this tool in your publication:</b><br><br>\n",
+    "Palmroos, C., Gieseler, J., Dresing N., Morosan D. E., Asvestari E., Yli-Laurila A., Price D. J., Valkila S., Vainio R. (2022).\n",
+    "Solar energetic particle time series analysis with Python. <i>Front. Astronomy Space Sci.</i> 9. <a href=\"https://doi.org/10.3389/fspas.2022.1073578\">doi:10.3389/fspas.2022.1073578</a>\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "5e05e989",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# add parent-parent dir to path so that seppy can be imported from there\n",
+    "import sys \n",
+    "sys.path.append('../../')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0eb22e28",
+   "metadata": {},
+   "source": [
+    "#### First import the necessary library"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "2a6f4f3b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from seppy.tools import Event\n",
+    "import seppy.tools.widgets as w\n",
+    "import datetime, os"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9b30a708",
+   "metadata": {},
+   "source": [
+    "#### Choose spacecraft, sensor, viewing direction and particle species from the drop-down menu:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "f0f78c1e",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "4e18dbfeecb545ce9937822840229059",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Dropdown(description='Spacecraft:', options=('PSP', 'SOHO', 'Solar Orbiter', 'STEREO-A', 'STEREO-B', 'Wind'), …"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "e4d208c9d56247589e2f6d6e7cdce78c",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Dropdown(description='Sensor:', options=('isois-epihi', 'isois-epilo'), value='isois-epihi')"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "879e5a4a10fa4cbdaf5b80623ebff13e",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Dropdown(description='Viewing:', options=('A', 'B'), value='A')"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "8b70ac3184b04b1e9f9cbc2291682e66",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Dropdown(description='Species:', options=('protons', 'electrons'), value='protons')"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "display(w.spacecraft_drop, w.sensor_drop, w.view_drop, w.species_drop)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "cab4dfae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# overwrite GUI returns for testing\n",
+    "w.spacecraft_drop.value = 'SOHO'\n",
+    "w.sensor_drop.value = 'ERNE-HED'\n",
+    "w.view_drop.value = None\n",
+    "w.species_drop.value = 'protons'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f72fd6b5",
+   "metadata": {},
+   "source": [
+    "#### Set the data path and date range to load data:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "c8b4570e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# The path to where data is located / to be downloaded (by default the current directory)\n",
+    "data_path = f\"{os.getcwd()}/data/\"\n",
+    "\n",
+    "# Format of date: year, month, day\n",
+    "startdate = datetime.date(2024, 5, 10)\n",
+    "enddate = datetime.date(2024, 5, 11)\n",
+    "\n",
+    "# Set the averaging period, or leave to None to not resample data\n",
+    "# averaging should be a pandas-compatible string, e.g. '1h', '2min', '15s'\n",
+    "averaging = '1min' #\"1min\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "b9184561",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Get event data:\n",
+    "Event_class = Event(spacecraft=w.spacecraft_drop.value, sensor=w.sensor_drop.value, \n",
+    "                    data_level='l2', species = w.species_drop.value, viewing=w.view_drop.value,\n",
+    "                    start_date=startdate, end_date=enddate, \n",
+    "                    data_path=data_path)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "af9b46b3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Select the channels to be plotted (first, last, step), end-exclusively (use None to choose all)\n",
+    "channels = (2, 8, 1) #(1, 11, 2)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3820516e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%matplotlib widget\n",
+    "Event_class.tsa_plot(w.view_drop.value, selection=channels, resample=averaging)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "fb9dd2f1",
+   "metadata": {},
+   "source": [
+    "#### Saving the figure is done in the plot window, by hovering mouse to the left side of the plot and clicking \"Download plot\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "a17ff153",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import matplotlib.pyplot as plt\n",
+    "plt.savefig('tsa_test.png')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "fbc35c0b",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "## FAQ / Problems <a class=\"anchor\" id=\"faq\"></a>\n",
+    "\n",
+    "- **I get some error about missing data, or that the data is broken, or something I don't understand.**\n",
+    "\n",
+    "Most times such a problem originates in an incomplete download of the corresponding data file. The easiest approach to solve that problem is to delete the file and run the code again to re-download it. \n",
+    "To do this, first check if a `path` has been provided. If `path` has *not* been defined (or as `None`), the standard `path` for SunPy downloads should have been used. You can obtain it by running the following code cell:\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "5a98af1b",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'/home/gieseler/sunpy/data'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import sunpy \n",
+    "sunpy.config.get('downloads', 'download_dir')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4ebec703",
+   "metadata": {},
+   "source": [
+    "Open the corresponding directory in your file browser and look for the corresponding data file. Usually it's easiest to order the files by modification date, so that the latest modified file (which usually should be the culprit) comes first. Then delete the corresponding file(s), and run the code again."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

seppy/tools/__init__.py

@@ -675,9 +675,9 @@ class Event:
 
             # An IndexError here is caused by invalid channel choice
             try:
-                en_channel_string = en_str[en_channel[0]][0].split()[0] + ' - '\
-                    + en_str[en_channel[-1]][0].split()[2] + ' ' +\
-                    en_str[en_channel[-1]][0].split()[3]
+                en_channel_string = en_str[en_channel[0]].flat[0].split()[0] + ' - '\
+                    + en_str[en_channel[-1]].flat[0].split()[2] + ' ' +\
+                    en_str[en_channel[-1]].flat[0].split()[3]
 
             except IndexError:
                 raise Exception(f"{en_channel} is an invalid channel or a combination of channels!")
@@ -781,9 +781,9 @@ class Event:
 
             # An IndexError here is caused by invalid channel choice
             try:
-                en_channel_string = en_str[en_channel[0]][0].split()[0] + ' - '\
-                    + en_str[en_channel[-1]][0].split()[2] + ' '\
-                    + en_str[en_channel[-1]][0].split()[3]
+                en_channel_string = en_str[en_channel[0]].flat[0].split()[0] + ' - '\
+                    + en_str[en_channel[-1]].flat[0].split()[2] + ' '\
+                    + en_str[en_channel[-1]].flat[0].split()[3]
 
             except IndexError:
                 raise Exception(f"{en_channel} is an invalid channel or a combination of channels!")
@@ -1782,7 +1782,7 @@ class Event:
             ax[DYN_SPEC_INDX].yaxis.set_major_formatter(ScalarFormatter(useMathText=False))
 
         # gets rid of minor ticks and labels
-        ax[DYN_SPEC_INDX].yaxis.set_tick_params(length=0, width=0, which='minor', labelsize=0.)
+        ax[DYN_SPEC_INDX].yaxis.minorticks_off()
         ax[DYN_SPEC_INDX].yaxis.set_tick_params(length=12., width=2.0, which='major')
 
         # x-axis settings
@@ -1898,7 +1898,7 @@ class Event:
             ax[DYN_SPEC_INDX].set_ylabel(f"Energy [{y_unit}]")
 
             # Introduce minor ticks back
-            ax[DYN_SPEC_INDX].yaxis.set_tick_params(length=8., width=1.2, which='minor', labelsize=0.)
+            ax[DYN_SPEC_INDX].yaxis.set_tick_params(length=8., width=1.2, which='minor')
 
             fig.set_size_inches((27, 18))
 
@@ -2061,7 +2061,7 @@ class Event:
         shift_coefficients = [METERS_PER_AU/v for v in particle_speeds]
 
         stepsize = 0.05
-        min_slider_val, max_slider_val = 0.0, 2.55
+        min_slider_val, max_slider_val = 0.0, 10
 
         # Only the selected channels will be plotted
         if selection is not None:
@@ -2276,8 +2276,8 @@ class Event:
                 p_identifier =  "Ion_Bins_Text" if self.sensor == "ept" else "H_Bins_Text" if self.sensor == "het" else "Bins_Text"
                 energy_ranges = energy_dict[p_identifier]
 
-            # Each element in the list is also a list with len==1, so fix that
-            energy_ranges = [element[0] for element in energy_ranges]
+            # Each element in the list is also a list with len==1 for cdflib < 1.3.3, so fix that
+            energy_ranges = energy_ranges.flatten()
 
         if self.spacecraft[:2] == "st":
 
@@ -2299,8 +2299,8 @@ class Event:
                 else:
                     energy_ranges = energy_dict["Proton_Bins_Text"]
 
-                # Each element in the list is also a list with len==1, so fix that
-                energy_ranges = [element[0] for element in energy_ranges]
+                # Each element in the list is also a list with len==1 for cdflib < 1.3.3, so fix that
+                energy_ranges = energy_ranges.flatten()
 
         if self.spacecraft == "soho":
             if self.sensor.lower() == "erne":
@@ -2322,9 +2322,8 @@ class Event:
                 if self.species == 'p':
                     energy_ranges = energy_dict["H_ENERGY_LABL"]
 
-                # In the case of ISOIS-EPIHI, each iterable object is a list with len=1 that contains
-                # the str
-                energy_ranges = [element[0] for element in energy_ranges]
+                # Each element in the list is also a list with len==1 for cdflib < 1.3.3, so fix that
+                energy_ranges = energy_ranges.flatten()
 
             if self.sensor == "isois-epilo":
                 # The metadata of ISOIS-EPILO comes in a bit of complex form, so some handling is required

seppy/version.py

@@ -1,8 +1,17 @@
-# Note that we need to fall back to the hard-coded version if either
-# setuptools_scm can't be imported or setuptools_scm can't determine the
-# version, so we catch the generic 'Exception'.
+# NOTE: First try _dev.scm_version if it exists and setuptools_scm is installed
+# This file is not included in wheels/tarballs, so otherwise it will
+# fall back on the generated _version module.
 try:
-    from setuptools_scm import get_version
-    __version__ = get_version(root='..', relative_to=__file__)
+    try:
+        from ._dev.scm_version import version
+    except ImportError:
+        from ._version import version
 except Exception:
-    __version__ = '0.1.17'
+    import warnings
+
+    warnings.warn(
+        f'could not determine {__name__.split(".")[0]} package version; this indicates a broken installation'
+    )
+    del warnings
+
+    version = '0.1.19'

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

@@ -1,28 +1,54 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: seppy
-Version: 0.1.17
+Version: 0.1.19
 Summary: SEPpy
-Home-page: https://github.com/serpentine-h2020/SEPpy
-Author: Jan Gieseler
-Author-email: jan.gieseler@utu.fi
-License: BSD 3-clause
+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.
+        
+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
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.8
-License-File: licenses/LICENSE.rst
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
 Requires-Dist: astropy
 Requires-Dist: astroquery
 Requires-Dist: bs4
 Requires-Dist: cdflib
+Requires-Dist: ipympl
 Requires-Dist: ipywidgets
 Requires-Dist: matplotlib
 Requires-Dist: mpl-animators>=1.0.0
@@ -32,7 +58,6 @@ Requires-Dist: pooch
 Requires-Dist: requests
 Requires-Dist: solo-epd-loader
 Requires-Dist: sunpy>=4.1.0
-Provides-Extra: all
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-doctestplus; extra == "test"
@@ -40,11 +65,12 @@ Requires-Dist: pytest-cov; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-automodapi; extra == "docs"
+Dynamic: license-file
 
 seppy
 =====
 
-|pypi Version| |python version| |pytest| |codecov| |zenodo doi|
+|pypi Version| |python version| |pytest| |codecov| |repostatus| |zenodo doi|
 
 .. |pypi Version| image:: https://img.shields.io/pypi/v/seppy?style=flat&logo=pypi
    :target: https://pypi.org/project/seppy/
@@ -54,6 +80,9 @@ seppy
 .. |pytest| image:: https://github.com/serpentine-h2020/SEPpy/actions/workflows/pytest.yml/badge.svg?branch=main
 .. |codecov| image:: https://codecov.io/gh/serpentine-h2020/SEPpy/branch/main/graph/badge.svg?token=FYELM4Y7DF 
    :target: https://codecov.io/gh/serpentine-h2020/SEPpy
+.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg
+   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
+   :target: https://www.repostatus.org/#active
 
 *This package is in development status! Intended for internal use only, as the syntax is in a floating state and the documentation is incomplete.*
 
@@ -77,7 +106,7 @@ This software is provided "as is", with no guarantee. It is no official data sou
 Installation
 ------------
 
-seppy requires python >= 3.8.
+seppy requires python >= 3.9.
 
 It can be installed from `PyPI <https://pypi.org/project/seppy/>`_ using:
 

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

@@ -1,5 +1,6 @@
-seppy/__init__.py,sha256=M8ZBbGj0r_XdNVLzaSXF38M4wyzAgUX32LXcSYh5O5A,254
-seppy/version.py,sha256=ZfyBAus4lEppBW04TYAwcehqpK2ZB149Kdo9PHYeWVg,346
+seppy/__init__.py,sha256=hk6JGncma6FHC5b8g5ZelvpsF1Jo-3Pz_3MneUcNWMg,156
+seppy/_version.py,sha256=-W-i-_6L24OJ73VmeltYID1xpUrwRUNYxZXkfU86ff0,513
+seppy/version.py,sha256=W_Fwi9aljZivAB9ddpA8HGKIrlvM1KDHRMxWdOz5ANo,532
 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
@@ -10,20 +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=PbxCEW-06d2I_JGIfIAqqXMU_uPdQFhmh-fUoXpzz9k,31535
-seppy/loader/soho.py,sha256=EIFKde1dGpT9yU6bU-XtTsHUCvTEkzHhdPOOMtqVrDU,20262
+seppy/loader/psp.py,sha256=dsFWF6OPPHSFqqiZwEL7_Y9pDQ6xUgg5biIGB1vsjh4,31546
+seppy/loader/soho.py,sha256=e6SzUD_WxUiaAMlWQcTGVvdER4Wv9rI-PtCCEoUHVRw,20290
 seppy/loader/solo.py,sha256=Nst2ZJU2yH5NHsB6M_69ryVfzt978hbmqhxaHZJREVg,3054
-seppy/loader/stereo.py,sha256=S0_IRIFbFxLH00bSIt1uZMflmuG5dAU5sKw0w9NL9oM,24583
-seppy/loader/wind.py,sha256=44zqFJsNn2fyLDi5SLkqTQO5iGCdVk5a8p7s28VVw6Y,18995
-seppy/tests/__init__.py,sha256=1D-l3TVbwIZHY78A-sB7kc4ldldX8ZaEq-Ntph51WVw,108
-seppy/tests/test_loader.py,sha256=mt52vrAeSEtJ-od4Cqt0HrscN_ykKNHklGZm8OTZjLs,7767
+seppy/loader/stereo.py,sha256=C0NM3xxzYS27Z6MbYJLRNM_sxw-5Ypx7QS2aoWt4Bco,24655
+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_time_shift_analysis.ipynb,sha256=4DIKqqRI_AdburzP9RnMwdOAvZovpgON2TJscDABIco,7904
 seppy/tests/test_tools.py,sha256=LQPekw-ddse88OYu-LWChFcJPT2SwGS7uEG1tKRLVok,31539
-seppy/tools/__init__.py,sha256=Ge3lQ9zVRJ27aaHSet2I1wQ9tD4emVfjnn49pUGcoiY,116086
+seppy/tests/tsa_org.png,sha256=80xrGx1unP1iXGLhPsKHHqMLrg2qhivsGh532hBVCqM,138501
+seppy/tools/__init__.py,sha256=nX_GL22ej9XLP6vHkKK_Ste8DtvVkusMEwHbO_wxvvQ,116011
 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.17.dist-info/LICENSE.rst,sha256=SxptLPCIHKdfDjyguGdC7ai6Eze-Vz_t1jdqC8h19js,1473
-seppy-0.1.17.dist-info/METADATA,sha256=zEKt2cdJMiv7iEUN_cuk8K24xvPOlHsirjA0n70h1ns,4398
-seppy-0.1.17.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-seppy-0.1.17.dist-info/top_level.txt,sha256=G2Op1GREPmbCX81isNhYY_7ZZyLWLIm-MJC04J4Fgc4,6
-seppy-0.1.17.dist-info/RECORD,,
+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-0.1.17.dist-info → seppy-0.1.19.dist-info}/WHEEL

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

seppy-0.1.19.dist-info/licenses/LICENSE.rst

@@ -0,0 +1,29 @@
+BSD 3-Clause 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:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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.

seppy-0.1.17.dist-info/LICENSE.rst

@@ -1,25 +0,0 @@
-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.