Skip to content

Commit

Permalink
Add support for first L1B FAST data (#98)
Browse files Browse the repository at this point in the history
* Correcting collections.

* Basic support for the Swarm FAST L1B collections.

* Bump version to 0.11.4-alpha

* Mention FAST data in docs

---------

Co-authored-by: Martin Paces <martin.paces@eox.at>
  • Loading branch information
smithara and pacesm committed Sep 21, 2023
1 parent bfeaf8a commit 2f63789
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/available_parameters.rst
Expand Up @@ -38,6 +38,10 @@ See the `Swarm Data Handbook`_ for details about the products and `Swarm Product
``collections``
---------------

.. note::

``FAST`` data will soon be available for some products. These are processed and made available faster than the traditional operational (``OPER``) data, mainly for space weather monitoring. The collection names are the same as those below, but replace ``OPER`` with ``FAST``.

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

======================== ================ ==============================================================
Expand Down
5 changes: 5 additions & 0 deletions docs/release_notes.rst
Expand Up @@ -4,6 +4,11 @@ Release notes
Change log
----------

Changes from 0.11.3 to 0.11.4
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Beginning support for (L1B) FAST data

Changes from 0.11.2 to 0.11.3
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion src/viresclient/__init__.py
Expand Up @@ -35,4 +35,4 @@
from ._config import ClientConfig, set_token
from ._data_handling import ReturnedData, ReturnedDataFile

__version__ = "0.11.3"
__version__ = "0.11.4-alpha"
20 changes: 16 additions & 4 deletions src/viresclient/_client_swarm.py
Expand Up @@ -495,9 +495,18 @@ class SwarmRequest(ClientRequest):
}

COLLECTIONS = {
"MAG": [f"SW_OPER_MAG{x}_LR_1B" for x in "ABC"],
"MAG_HR": [f"SW_OPER_MAG{x}_HR_1B" for x in "ABC"],
"EFI": [f"SW_OPER_EFI{x}_LP_1B" for x in "ABC"],
"MAG": [
*(f"SW_OPER_MAG{x}_LR_1B" for x in "ABC"),
*(f"SW_FAST_MAG{x}_LR_1B" for x in "ABC"),
],
"MAG_HR": [
*(f"SW_OPER_MAG{x}_HR_1B" for x in "ABC"),
*(f"SW_FAST_MAG{x}_HR_1B" for x in "ABC"),
],
"EFI": [
*(f"SW_OPER_EFI{x}_LP_1B" for x in "ABC"),
*(f"SW_FAST_EFI{x}_LP_1B" for x in "ABC"),
],
"EFI_IDM": [f"SW_PREL_EFI{x}IDM_2_" for x in "ABC"],
"EFI_TIE": [f"SW_OPER_EFI{x}TIE_2_" for x in "ABC"],
"EFI_TCT02": [f"SW_EXPT_EFI{x}_TCT02" for x in "ABC"],
Expand Down Expand Up @@ -622,7 +631,10 @@ class SwarmRequest(ClientRequest):
"MAG_GOCE": ["GO_MAG_ACAL_CORR"],
"MAG_GOCE_ML": ["GO_MAG_ACAL_CORR_ML"],
# Swarm spacecraft positions
"MOD_SC": [f"SW_OPER_MOD{x}_SC_1B" for x in "ABC"],
"MOD_SC": [
*(f"SW_OPER_MOD{x}_SC_1B" for x in "ABC"),
*(f"SW_FAST_MOD{x}_SC_1B" for x in "ABC"),
],
}

OBS_COLLECTIONS = [
Expand Down

0 comments on commit 2f63789

Please sign in to comment.