From 853fdf2bbcad296bbeebbcd5b4a724ab78224738 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 17:17:13 +0000 Subject: [PATCH 1/6] Bump actions/setup-python from 5 to 6 Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v5...v6) --- updated-dependencies: - dependency-name: actions/setup-python dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0931638..5e00048 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/setup-python@v6 - uses: pre-commit/action@v3.0.1 with: extra_args: --hook-stage manual --all-files @@ -37,7 +37,7 @@ jobs: python-version: 3.14 steps: - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} - name: Install uv From d1a56490fca42e4eff6da93001b62d2c78057902 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 17:17:19 +0000 Subject: [PATCH 2/6] Bump astral-sh/setup-uv from 4 to 7 Bumps [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) from 4 to 7. - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/v4...v7) --- updated-dependencies: - dependency-name: astral-sh/setup-uv dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0931638..4413bdb 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -41,7 +41,7 @@ jobs: with: python-version: ${{ matrix.python-version }} - name: Install uv - uses: astral-sh/setup-uv@v4 + uses: astral-sh/setup-uv@v7 - name: Install package run: uv sync ${{ github.event_name == 'schedule' && '--upgrade' || '--frozen' }} --group test - name: Configure token access From da9db91d09f0ed33325263c341e23169e01d2ff4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 17:19:49 +0000 Subject: [PATCH 3/6] Bump actions/checkout from 3 to 6 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 6. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 4 ++-- .github/workflows/publish.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bc481f4..014d243 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -14,7 +14,7 @@ jobs: name: Format runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 - uses: pre-commit/action@v3.0.1 with: @@ -36,7 +36,7 @@ jobs: - os: ubuntu-24.04 python-version: 3.14 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fb7bd8d..df66b9f 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v6 with: fetch-depth: 0 From 7df001350aa16eea4afceab388074704a785f012 Mon Sep 17 00:00:00 2001 From: Martin Paces Date: Wed, 30 Sep 2026 22:32:42 +0200 Subject: [PATCH 4/6] feat: support for the SW_STRxEPF_1B products. --- src/viresclient/_client_swarm.py | 33 ++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/viresclient/_client_swarm.py b/src/viresclient/_client_swarm.py index 4da7616..b01e1fa 100644 --- a/src/viresclient/_client_swarm.py +++ b/src/viresclient/_client_swarm.py @@ -237,6 +237,8 @@ ), "ULF_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_ULFxMAG_2F",), "PC1_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_PC1xMAG_2F",), + "STR_EPF": ("https://swarmhandbook.earth.esa.int/catalogue/SW_STRXEPF_1B",), + "STR_EPF:flattened": ("https://swarmhandbook.earth.esa.int/catalogue/SW_STRXEPF_1B",), } for mission in ("SW", "OR", "CH", "CR", "CO"): for cadence in ("1M", "4M"): @@ -725,6 +727,14 @@ class SwarmRequest(ClientRequest): *(f"SW_OPER_PC1{spacecraft}MAG_2F:Br_event_mean" for spacecraft in "ABC"), *(f"SW_OPER_PC1{spacecraft}MAG_2F:Ba_event_mean" for spacecraft in "ABC"), ], + "STR_EPF": [ + *(f"SW_OPER_STR{spacecraft}EPF_1B" for spacecraft in "ABC"), + *(f"SW_FAST_STR{spacecraft}EPF_1B" for spacecraft in "ABC"), + ], + "STR_EPF:flattened": [ + *(f"SW_OPER_STR{spacecraft}EPF_1B:flattened" for spacecraft in "ABC"), + *(f"SW_FAST_STR{spacecraft}EPF_1B:flattened" for spacecraft in "ABC"), + ], } OBS_COLLECTIONS = [ @@ -820,6 +830,8 @@ class SwarmRequest(ClientRequest): "ULF_MAG:event_mean": "PT1M", # irregular sampling "PC1_MAG:event": "PT1S", # irregular sampling "PC1_MAG:event_mean": "PT1M", # irregular sampling + "STR_EPF": "PT1S", + "STR_EPF:flattened": "PT1S", } PRODUCT_VARIABLES = { @@ -1531,6 +1543,27 @@ class SwarmRequest(ClientRequest): "ROFC", "Quality", ], + "STR_EPF": [ + "EPF", + "EPD", + "T_CHU", + "RA", + "Dec", + "EPD_Dens_corr", + "EPD_T_corr", + "Flags_EPF", + ], + "STR_EPF:flattened": [ + "EPF", + "EPD", + "T_CHU", + "RA", + "Dec", + "EPD_Dens_corr", + "EPD_T_corr", + "Flags_EPF", + "SensorId", + ], } AUXILIARY_VARIABLES = [ From 08c3c92297eef5ad41258d8d43e0b6d23eb48436 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Thu, 1 Oct 2026 14:14:57 +0100 Subject: [PATCH 5/6] Add doc reference to STRxEPF and bump to v0.17.0 --- docs/available_parameters.rst | 34 ++++++++++++++++++-------------- docs/release_notes.rst | 5 +++++ src/viresclient/__init__.py | 2 +- src/viresclient/_client_swarm.py | 4 +++- 4 files changed, 28 insertions(+), 17 deletions(-) diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index 031be08..d5bc923 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -55,6 +55,7 @@ The available measurements are segregated according to the "collection" (essenti - ``SW_FAST_AEJxLPL_2F`` - ``SW_FAST_AEJxPBL_2F`` - ``SW_FAST_AOBxFAC_2F`` + - ``SW_FAST_STRxEPF_1B`` Collections are grouped according to a type containing similar measurements (i.e. the same product from different spacecraft). The collection type can be given to :py:meth:`viresclient.SwarmRequest.available_collections` to retrieve the full collection names. These cover the Swarm data products as below (replace x with A, B, or C for Alpha, Bravo, or Charlie): @@ -75,6 +76,7 @@ SW_OPER_FAC_TMS_2F FAC Field-aligned currents (dual-satellite SW_OPER_EEFxTMS_2F EEF Equatorial electric field SW_OPER_IBIxTMS_2F IBI Ionospheric bubble index SW_OPER_MODx_SC_1B MOD_SC Spacecraft positions at 1Hz +SW_OPER_STRxEPF_1B STR_EPF Star tracker energetic particle flux ======================== ================ ============================================================== The AEBS (auroral electrojets and boundaries) products are a bit more complicated: @@ -220,21 +222,23 @@ The ``measurements``, ``models``, and ``auxiliaries`` chosen will match the cade Choose combinations of measurements from one of the following sets, corresponding to the collection chosen above. The collection full name or collection type can be given to :py:meth:`viresclient.SwarmRequest.available_measurements` to retrieve the list of available measurements for a given collection (e.g. ``request.available_measurements("SW_OPER_MAGA_LR_1B")``) -=============== ============================================================================================================================================================================================================================================================================================== -Collection type Available measurement names -=============== ============================================================================================================================================================================================================================================================================================== -MAG ``F,dF_Sun,dF_AOCS,dF_other,F_error,B_VFM,B_NEC,dB_Sun,dB_AOCS,dB_other,B_error,q_NEC_CRF,Att_error,Flags_F,Flags_B,Flags_q,Flags_Platform,ASM_Freq_Dev`` -MAG_HR ``F,B_VFM,B_NEC,dB_Sun,dB_AOCS,dB_other,B_error,q_NEC_CRF,Att_error,Flags_B,Flags_q,Flags_Platform,ASM_Freq_Dev`` -EFI ``U_orbit,Ne,Ne_error,Te,Te_error,Vs,Vs_error,Flags_LP,Flags_Ne,Flags_Te,Flags_Vs`` -EFI_TIE ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,Tn_msis,Te_adj_LP,Ti_meas_drift,Ti_model_drift,Flag_ti_meas,Flag_ti_model`` -EFI_TCTyy ``VsatC,VsatE,VsatN,Bx,By,Bz,Ehx,Ehy,Ehz,Evx,Evy,Evz,Vicrx,Vicry,Vicrz,Vixv,Vixh,Viy,Viz,Vixv_error,Vixh_error,Viy_error,Viz_error,Latitude_QD,MLT_QD,Calibration_flags,Quality_flags`` -EFI_IDM ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,V_sat_nec,M_i_eff,M_i_eff_err,M_i_eff_Flags,M_i_eff_tbt_model,V_i,V_i_err,V_i_Flags,V_i_raw,N_i,N_i_err,N_i_Flags,A_fp,R_p,T_e,Phi_sc`` -IPD ``Ne,Te,Background_Ne,Foreground_Ne,PCP_flag,Grad_Ne_at_100km,Grad_Ne_at_50km,Grad_Ne_at_20km,Grad_Ne_at_PCP_edge,ROD,RODI10s,RODI20s,delta_Ne10s,delta_Ne20s,delta_Ne40s,Num_GPS_satellites,mVTEC,mROT,mROTI10s,mROTI20s,IBI_flag,Ionosphere_region_flag,IPIR_index,Ne_quality_flag,TEC_STD`` -TEC ``GPS_Position,LEO_Position,PRN,L1,L2,P1,P2,S1,S2,Elevation_Angle,Absolute_VTEC,Absolute_STEC,Relative_STEC,Relative_STEC_RMS,DCB,DCB_Error`` -FAC ``IRC,IRC_Error,FAC,FAC_Error,Flags,Flags_F,Flags_B,Flags_q`` -EEF ``EEF,EEJ,RelErr,Flags`` -IBI ``Bubble_Index,Bubble_Probability,Flags_Bubble,Flags_F,Flags_B,Flags_q`` -=============== ============================================================================================================================================================================================================================================================================================== +================== ============================================================================================================================================================================================================================================================================================== +Collection type Available measurement names +================== ============================================================================================================================================================================================================================================================================================== +MAG ``F,dF_Sun,dF_AOCS,dF_other,F_error,B_VFM,B_NEC,dB_Sun,dB_AOCS,dB_other,B_error,q_NEC_CRF,Att_error,Flags_F,Flags_B,Flags_q,Flags_Platform,ASM_Freq_Dev`` +MAG_HR ``F,B_VFM,B_NEC,dB_Sun,dB_AOCS,dB_other,B_error,q_NEC_CRF,Att_error,Flags_B,Flags_q,Flags_Platform,ASM_Freq_Dev`` +EFI ``U_orbit,Ne,Ne_error,Te,Te_error,Vs,Vs_error,Flags_LP,Flags_Ne,Flags_Te,Flags_Vs`` +EFI_TIE ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,Tn_msis,Te_adj_LP,Ti_meas_drift,Ti_model_drift,Flag_ti_meas,Flag_ti_model`` +EFI_TCTyy ``VsatC,VsatE,VsatN,Bx,By,Bz,Ehx,Ehy,Ehz,Evx,Evy,Evz,Vicrx,Vicry,Vicrz,Vixv,Vixh,Viy,Viz,Vixv_error,Vixh_error,Viy_error,Viz_error,Latitude_QD,MLT_QD,Calibration_flags,Quality_flags`` +EFI_IDM ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,V_sat_nec,M_i_eff,M_i_eff_err,M_i_eff_Flags,M_i_eff_tbt_model,V_i,V_i_err,V_i_Flags,V_i_raw,N_i,N_i_err,N_i_Flags,A_fp,R_p,T_e,Phi_sc`` +IPD ``Ne,Te,Background_Ne,Foreground_Ne,PCP_flag,Grad_Ne_at_100km,Grad_Ne_at_50km,Grad_Ne_at_20km,Grad_Ne_at_PCP_edge,ROD,RODI10s,RODI20s,delta_Ne10s,delta_Ne20s,delta_Ne40s,Num_GPS_satellites,mVTEC,mROT,mROTI10s,mROTI20s,IBI_flag,Ionosphere_region_flag,IPIR_index,Ne_quality_flag,TEC_STD`` +TEC ``GPS_Position,LEO_Position,PRN,L1,L2,P1,P2,S1,S2,Elevation_Angle,Absolute_VTEC,Absolute_STEC,Relative_STEC,Relative_STEC_RMS,DCB,DCB_Error`` +FAC ``IRC,IRC_Error,FAC,FAC_Error,Flags,Flags_F,Flags_B,Flags_q`` +EEF ``EEF,EEJ,RelErr,Flags`` +IBI ``Bubble_Index,Bubble_Probability,Flags_Bubble,Flags_F,Flags_B,Flags_q`` +STR_EPF ``EPF,EPD,T_CHU,RA,Dec,EPD_Dens_corr,EPD_T_corr,Flags_EPF`` +STR_EPF:flattened ``EPF,EPD,T_CHU,RA,Dec,EPD_Dens_corr,EPD_T_corr,Flags_EPF,SensorId`` +================== ============================================================================================================================================================================================================================================================================================== AEBS products: diff --git a/docs/release_notes.rst b/docs/release_notes.rst index cc6b74b..b79a7b3 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -4,6 +4,11 @@ Release notes Change log ---------- +Changes from 0.16.0 to 0.17.0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Added new `STRxEPF `_ product + Changes from 0.15.2 to 0.16.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src/viresclient/__init__.py b/src/viresclient/__init__.py index 04872c1..a0100ed 100644 --- a/src/viresclient/__init__.py +++ b/src/viresclient/__init__.py @@ -35,4 +35,4 @@ from ._config import ClientConfig, set_token from ._data_handling import ReturnedData, ReturnedDataFile -__version__ = "0.16.0" +__version__ = "0.17.0" diff --git a/src/viresclient/_client_swarm.py b/src/viresclient/_client_swarm.py index b01e1fa..d4f2223 100644 --- a/src/viresclient/_client_swarm.py +++ b/src/viresclient/_client_swarm.py @@ -238,7 +238,9 @@ "ULF_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_ULFxMAG_2F",), "PC1_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_PC1xMAG_2F",), "STR_EPF": ("https://swarmhandbook.earth.esa.int/catalogue/SW_STRXEPF_1B",), - "STR_EPF:flattened": ("https://swarmhandbook.earth.esa.int/catalogue/SW_STRXEPF_1B",), + "STR_EPF:flattened": ( + "https://swarmhandbook.earth.esa.int/catalogue/SW_STRXEPF_1B", + ), } for mission in ("SW", "OR", "CH", "CR", "CO"): for cadence in ("1M", "4M"): From 9847254a5891ffbb08b87baecc49ccfecb06e766 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Thu, 1 Oct 2026 18:11:44 +0100 Subject: [PATCH 6/6] Add labelling of CHU number 1-3 --- docs/release_notes.rst | 1 + src/viresclient/_data_handling.py | 17 ++++++++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index b79a7b3..0f74f3f 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -8,6 +8,7 @@ Changes from 0.16.0 to 0.17.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Added new `STRxEPF `_ product +- Per-CHU variables in ``STR_EPF`` are given a shared ``CHU`` dimension (labelled 1, 2, 3) in xarray, and expanded to ``_1``, ``_2``, ``_3`` in pandas with ``expand=True`` Changes from 0.15.2 to 0.16.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src/viresclient/_data_handling.py b/src/viresclient/_data_handling.py index 0b0cb7c..06370ef 100644 --- a/src/viresclient/_data_handling.py +++ b/src/viresclient/_data_handling.py @@ -57,6 +57,16 @@ "WGS84": ["GPS_Position", "LEO_Position"], "EEJ_QDLat": ["EEJ_meast", "EEJ_mnorth"], "NE": ["J_NE", "J_CF_NE", "J_DF_NE", "B_NE"], + "CHU": [ + "EPF", + "EPD", + "T_CHU", + "RA", + "Dec", + "EPD_Dens_corr", + "EPD_T_corr", + "Flags_EPF", + ], } # Reverse mapping of the above DATANAMES_TO_FRAME_NAMES = {} @@ -72,12 +82,14 @@ "WGS84": ["X", "Y", "Z"], "EEJ_QDLat": numpy.linspace(-20, 20, 81), "NE": ["N", "E"], + "CHU": [1, 2, 3], } FRAME_DESCRIPTIONS = { "NEC": "NEC frame - North, East, Centre (down)", "NE": "Horizontal NE frame - North, East", "VFM": "Vector Field Magnetometer instrument frame", "EEJ_QDLat": "Quasi-dipole latitude profile between -20 and 20 degrees from the EEF product", + "CHU": "Star tracker Camera Head Unit (CHU) identifier", } @@ -205,10 +217,13 @@ def as_pandas_dataframe(self, expand=False): columns.remove(self._time_variable) # Split columns according to those to be expanded into multiple columns if expand: + # Only expand vector variables (e.g. not the scalar per-CHU + # variables in the STR_EPF:flattened collections) columns_to_expand = { c for c in columns - if c in DATANAMES_TO_FRAME_NAMES.keys() or "B_NEC" in c + if (c in DATANAMES_TO_FRAME_NAMES.keys() or "B_NEC" in c) + and self.get_variable_numdims(c) == 1 } # Avoid conflict with 2D AOB_FAC Quality variable # when accessing AUX_OBS Quality