Skip to content

Commit 70dd326

Browse files
smitharasmithara
committed
Update docs and bump to v0.16.0
1 parent 5e008d5 commit 70dd326

8 files changed

Lines changed: 36 additions & 38 deletions

File tree

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ repos:
2222
- id: mixed-line-ending
2323
- id: requirements-txt-fixer
2424
- id: trailing-whitespace
25+
exclude: CITATION.cff
2526

2627
- repo: https://github.com/pre-commit/pygrep-hooks
2728
rev: v1.10.0

‎CITATION.cff‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ title: ESA-VirES/VirES-Python-Client
66
message: >-
77
Example citation:
88
9-
“We use the Python package, viresclient [1], to access [ name the datasets ] from ESA's VirES for Swarm service [2]"
9+
“We use the Python package, viresclient [1], to access [ name the datasets ] from ESA's VirES for Swarm service [2]".
1010
11-
[1] Smith, A. R. A., Pačes, M., & Santillan, D. (2025). ESA-VirES/VirES-Python-Client. Zenodo. https://doi.org/10.5281/zenodo.2554162
12-
[2] https://vires.services
11+
[1] Smith, A. R. A., Pačes, M., & Santillan, D. (2025). ESA-VirES/VirES-Python-Client. Zenodo. https://doi.org/10.5281/zenodo.2554162.
12+
[2] https://vires.services
1313
14-
You may also wish to cite this paper:
14+
You may also wish to cite this paper:
1515
16-
Smith A.R.A., Pačes M. and Swarm DISC (2022) Python tools for ESA's Swarm mission: VirES for Swarm and surrounding ecosystem. Front. Astron. Space Sci. 9:1002697. https://doi.org/10.3389/fspas.2022.1002697
16+
Smith A.R.A., Pačes M. and Swarm DISC (2022) Python tools for ESA's Swarm mission: VirES for Swarm and surrounding ecosystem. Front. Astron. Space Sci. 9:1002697. https://doi.org/10.3389/fspas.2022.1002697.
1717
1818
Please refer to the Swarm handbook for product references: https://swarmhandbook.earth.esa.int/
1919
type: software

‎README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ You can reference *viresclient* directly using the DOI of our zenodo_ record. Vi
120120

121121
“We use the Python package, viresclient [1], to access [ name the datasets... ] from ESA's VirES for Swarm service [2]"
122122

123-
[1] Smith, A. R. A., Pačes, M., & Santillan, D. (2025). ESA-VirES/VirES-Python-Client. Zenodo. Smith, A. R. A., Pačes, M., & Santillan, D. (2025). ESA-VirES/VirES-Python-Client. Zenodo. https://doi.org/10.5281/zenodo.2554162
123+
[1] Smith, A. R. A., Pačes, M., & Santillan, D. (2025). ESA-VirES/VirES-Python-Client. Zenodo. https://doi.org/10.5281/zenodo.2554162
124124
[2] https://vires.services
125125

126126
(To follow best practices you should cite the specific version that you used - refer to the Zenodo page to find the correct DOI for that version)

‎docs/_templates/sections/header.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<a href="https://swarmpal.readthedocs.io" class="link">SwarmPAL</a>
88
<a href="https://vires.services" target="_blank" class="link">VirES for Swarm↗</a>
99
<a href="https://vre.vires.services" target="_blank" class="link">Swarm JupyterHub↗</a>
10+
<a href="https://dev.swarmdisc.org/dashboards/vires-query" target="_blank" class="link link-highlight">New! Query builder↗</a>
1011
</div>
1112
<div style="width: 100%; height: 5px;"></div>
1213
<div class="section">
@@ -48,6 +49,14 @@
4849
color: #1e90ff !important;
4950
}
5051

52+
.custom-header-container .link-highlight {
53+
background-color: #ffc107;
54+
color: #333 !important;
55+
border-radius: 4px;
56+
font-weight: bold;
57+
padding: 3px 8px;
58+
}
59+
5160
.custom-header-container .link-selected {
5261
margin: 0 5px;
5362
padding: 5px 5px;

‎docs/available_parameters.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ The available measurements are segregated according to the "collection" (essenti
5252
- ``SW_FAST_MODx_SC_1B``
5353
- ``SW_FAST_FACxTMS_2F``
5454
- ``SW_FAST_TECxTMS_2F``
55+
- ``SW_FAST_AEJxLPL_2F``
56+
- ``SW_FAST_AEJxPBL_2F``
57+
- ``SW_FAST_AOBxFAC_2F``
5558

5659
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):
5760

‎docs/release_notes.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Changes from 0.15.2 to 0.16.0
88
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99

1010
- Fix usage of ``reshape=True`` when using ``AUX_OBSH`` collection (via creating an additional ``SiteCode`` data variable)
11+
- Add more FAST product variants: ``SW_FAST_AEJxLPL_2F``, ``SW_FAST_AEJxPBL_2F``, ``SW_FAST_AOBxFAC_2F``
1112

1213
Changes from 0.15.1 to 0.15.2
1314
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

‎src/viresclient/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@
3535
from ._config import ClientConfig, set_token
3636
from ._data_handling import ReturnedData, ReturnedDataFile
3737

38-
__version__ = "0.16.0-alpha"
38+
__version__ = "0.16.0"

‎src/viresclient/_client_swarm.py‎

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -51,23 +51,23 @@
5151
" https://www.ncei.noaa.gov/products/international-geomagnetic-reference-field ",
5252
),
5353
"CHAOS-Core": (
54-
"CHAOS-8 Core field (SH degrees 1-20)",
54+
"CHAOS Core field (SH degrees 1-20)",
5555
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
5656
),
5757
"CHAOS-Static": (
58-
"CHAOS-8 crust field (SH degrees 21-185)",
58+
"CHAOS crust field (SH degrees 21-185)",
5959
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
6060
),
6161
"CHAOS-MMA-Primary": (
62-
"CHAOS-8 Primary (external) magnetospheric field",
62+
"CHAOS Primary (external) magnetospheric field",
6363
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
6464
),
6565
"CHAOS-MMA-Secondary": (
66-
"CHAOS-8 Secondary (internal) magnetospheric field",
66+
"CHAOS Secondary (internal) magnetospheric field",
6767
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
6868
),
6969
"CHAOS-MIO": (
70-
"CHAOS-8 Ionospheric field",
70+
"CHAOS Ionospheric field",
7171
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
7272
),
7373
"MF7": (
@@ -79,75 +79,59 @@
7979
" http://www.spacecenter.dk/files/magnetic-models/LCS-1/",
8080
),
8181
"MCO_SHA_2C": (
82-
"[Comprehensive Inversion]: Core field of CIY4",
82+
"[Comprehensive Inversion]: Core field",
8383
"https://swarmhandbook.earth.esa.int/catalogue/sw_mco_sha_2c",
84-
" A comprehensive model of Earth’s magnetic field determined from 4 years of Swarm satellite observations, https://doi.org/10.1186/s40623-018-0896-3 ",
85-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MCO/SW_OPER_MCO_VAL_2C_20131201T000000_20180101T000000_0401.ZIP ",
8684
),
8785
"MCO_SHA_2D": (
8886
"[Dedicated Chain]: Core field",
8987
"https://swarmhandbook.earth.esa.int/catalogue/sw_mco_sha_2d",
90-
"An algorithm for deriving core magnetic field models from the Swarm data set, https://doi.org/10.5047/eps.2013.07.005 ",
91-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MCO/SW_OPER_MCO_VAL_2D_20131126T000000_20180101T000000_0401.ZIP ",
9288
),
9389
"MLI_SHA_2C": (
94-
"[Comprehensive Inversion]: Lithospheric field of CIY4",
90+
"[Comprehensive Inversion]: Lithospheric field",
9591
"https://swarmhandbook.earth.esa.int/catalogue/sw_mli_sha_2c",
96-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MLI/SW_OPER_MLI_VAL_2C_00000000T000000_99999999T999999_0401.ZIP",
9792
),
9893
"MLI_SHA_2D": (
9994
"[Dedicated Chain]: Lithospheric field",
10095
"https://swarmhandbook.earth.esa.int/catalogue/sw_mli_sha_2d",
101-
" Swarm SCARF Dedicated Lithospheric Field Inversion chain, https://doi.org/10.5047/eps.2013.07.008 ",
102-
" Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MLI/SW_OPER_MLI_VAL_2D_00000000T000000_99999999T999999_0401.ZIP ",
10396
),
10497
"MLI_SHA_2E": (
10598
"[Extended dedicated chain]: Lithospheric field",
10699
"https://swarmhandbook.earth.esa.int/catalogue/sw_mli_sha_2e",
107-
" Joint inversion of Swarm, CHAMP, and WDMAM data ",
108-
" https://swarm-diss.eo.esa.int/?do=download&file=swarm%2FLevel2longterm%2FMLI%2FSW_OPER_MLI_VAL_2E_00000000T000000_99999999T999999_0502.ZIP ",
109100
),
110101
"MMA_SHA_2C-Primary": (
111-
"[Comprehensive Inversion]: Primary (external) magnetospheric field of CIY4",
102+
"[Comprehensive Inversion]: Primary (external) magnetospheric field",
112103
"https://swarmhandbook.earth.esa.int/catalogue/sw_mma_sha_2c",
113-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MMA/SW_OPER_MMA_VAL_2C_20131201T000000_20180101T000000_0401.ZIP",
114104
),
115105
"MMA_SHA_2C-Secondary": (
116106
"https://swarmhandbook.earth.esa.int/catalogue/sw_mma_sha_2c",
117-
"[Comprehensive Inversion]: Secondary (internal/induced) magnetospheric field of CIY4",
107+
"[Comprehensive Inversion]: Secondary (internal/induced) magnetospheric field",
118108
),
119109
"MMA_SHA_2F-Primary": (
120110
"[Fast-Track Product]: Primary (external) magnetospheric field",
121111
"https://swarmhandbook.earth.esa.int/catalogue/sw_mma_sha_2f",
122-
" Rapid modelling of the large-scale magnetospheric field from Swarm satellite data, https://doi.org/10.5047/eps.2013.09.003 ",
123112
),
124113
"MMA_SHA_2F-Secondary": (
125114
"[Fast-Track Product]: Secondary (internal/induced) magnetospheric field",
126115
"https://swarmhandbook.earth.esa.int/catalogue/sw_mma_sha_2f",
127116
),
128117
"MIO_SHA_2C-Primary": (
129-
"[Comprehensive Inversion]: Primary (external) ionospheric field of CIY4",
118+
"[Comprehensive Inversion]: Primary (external) ionospheric field",
130119
"https://swarmhandbook.earth.esa.int/catalogue/sw_mio_sha_2c",
131-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MIO/SW_OPER_MIO_VAL_2C_00000000T000000_99999999T999999_0401.ZIP ",
132120
),
133121
"MIO_SHA_2C-Secondary": (
134-
"[Comprehensive Inversion]: Secondary (external/induced) ionospheric field of CIY4",
122+
"[Comprehensive Inversion]: Secondary (external/induced) ionospheric field",
135123
"https://swarmhandbook.earth.esa.int/catalogue/sw_mio_sha_2c",
136124
),
137125
"MIO_SHA_2D-Primary": (
138126
"[Dedicated Chain]: Primary (external) ionospheric field, DIFI",
139127
"https://swarmhandbook.earth.esa.int/catalogue/sw_mio_sha_2d",
140-
" Swarm SCARF dedicated ionospheric field inversion chain, https://doi.org/10.5047/eps.2013.08.006 ",
141-
" First results from the Swarm Dedicated Ionospheric Field Inversion chain, https://doi.org/10.1186/s40623-016-0481-6 ",
142-
" http://geomag.colorado.edu/difi-3 ",
143-
"Validation: ftp://swarm-diss.eo.esa.int/Level2longterm/MIO/SW_OPER_MIO_VAL_2D_20131201T000000_20171231T235959_0402.ZIP ",
144128
),
145129
"MIO_SHA_2D-Secondary": (
146130
"[Dedicated Chain]: Secondary (external/induced) ionospheric field, DIFI",
147131
"https://swarmhandbook.earth.esa.int/catalogue/sw_mio_sha_2d",
148132
),
149133
"AMPS": (
150-
"AMPS - associated magnetic field, https://github.com/klaundal/pyAMPS",
134+
"AMPS - Polar currents magnetic field, https://github.com/klaundal/pyAMPS",
151135
"https://swarmhandbook.earth.esa.int/catalogue/sw_mio_sha_2e",
152136
),
153137
"MCO_SHA_2X": (
@@ -261,9 +245,9 @@
261245
)
262246

263247
DATA_CITATIONS = {
264-
"AUX_OBSH": "ftp://ftp.nerc-murchison.ac.uk/geomag/Swarm/AUX_OBS/hour/README",
265-
"AUX_OBSM": "ftp://ftp.nerc-murchison.ac.uk/geomag/Swarm/AUX_OBS/minute/README",
266-
"AUX_OBSS": "ftp://ftp.nerc-murchison.ac.uk/geomag/Swarm/AUX_OBS/second/README",
248+
"AUX_OBSH": "https://auxobs-api.bgs.ac.uk/docs",
249+
"AUX_OBSM": "https://auxobs-api.bgs.ac.uk/docs",
250+
"AUX_OBSS": "https://auxobs-api.bgs.ac.uk/docs",
267251
}
268252

269253
IAGA_CODES = CONFIG_SWARM.get("IAGA_CODES")

0 commit comments

Comments
 (0)