From bb9759d6b328096df2e1aca6fc5d5678c4a0ccff Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Fri, 28 Mar 2025 19:26:15 +0000 Subject: [PATCH 1/8] Update documentation build and changelog --- .readthedocs.yml | 4 ++-- docs/available_parameters.rst | 1 + docs/release_notes.rst | 25 +++++++++++++++++++++++++ noxfile.py | 4 ++-- pyproject.toml | 8 ++++---- 5 files changed, 34 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index c3844b2..f3ccb19 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,9 +7,9 @@ version: 2 # Set the OS, Python version and other tools you might need build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.8" + python: "3.12" # Build documentation in the docs/ directory with Sphinx sphinx: diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index e576d19..52fb2b0 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -123,6 +123,7 @@ SW_OPER_TIX_TMS_2F TIX_TMS ============================== ================ The `TIRO project `_ provides products for TEC and Ne derived from CHAMP, GRACE, and GRACE-FO: + ============================== ================ Collection full name Collection type ============================== ================ diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 12c4904..7738e39 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -4,6 +4,31 @@ Release notes Change log ---------- +Changes from 0.12.3 to 0.13.0 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Added support for new products: + + - Swarm `ULF wave project `_: + + - ``SW_OPER_ULFxMAG_2F`` + - ``SW_OPER_PC1xMAG_2F`` + + - `MIGRAS project `_ providing ionospheric gradients of TEC and electron density: + + - ``SW_OPER_NIX_TMS_2F`` + - ``SW_OPER_TIX_TMS_2F`` + + - `TIRO project `_ providing TEC and electron density derived from CHAMP, GRACE, and GRACE-FO: + + - ``CH_OPER_TEC_TMS_2F`` + - ``GR_OPER_TECxTMS_2F`` + - ``GF_OPER_TECxTMS_2F`` + - ``GR_OPER_NE__KBR_2F`` + - ``GF_OPER_NE__KBR_2F`` + +- Added :py:meth:`viresclient.SwarmRequest.get_collection_info` to query collection details from server (e.g. time extent) + Changes from 0.12.2 to 0.12.3 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/noxfile.py b/noxfile.py index b491533..1e58e55 100644 --- a/noxfile.py +++ b/noxfile.py @@ -10,14 +10,14 @@ def lint(session): session.run("pre-commit", "run", "--all-files", *session.posargs) -@nox.session(python=["3.6", "3.7", "3.8", "3.9", "3.10"]) +@nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]) def tests(session): session.install(".") session.install("pytest") session.run("pytest") -@nox.session +@nox.session(python="3.12") def docs(session: nox.Session) -> None: """ Build the docs. Pass "serve" to serve. diff --git a/pyproject.toml b/pyproject.toml index 5987cc9..23eb1f7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,10 +57,10 @@ dev = [ "nox >=2022", ] docs = [ - "Sphinx == 4.5.0", - "sphinx-book-theme == 0.3.3", - "sphinx_copybutton == 0.5.0", - "sphinx-tabs == 3.4.0", + "Sphinx == 8.2", + "sphinx-book-theme == 1.1.4", + "sphinx-copybutton == 0.5.2", + "sphinx-tabs == 3.4.7", ] [project.scripts] From fde584126542e334d793f21e23d3b5433ed16c3d Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Fri, 28 Mar 2025 19:27:57 +0000 Subject: [PATCH 2/8] format --- docs/release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 7738e39..4d1942a 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -20,7 +20,7 @@ Changes from 0.12.3 to 0.13.0 - ``SW_OPER_TIX_TMS_2F`` - `TIRO project `_ providing TEC and electron density derived from CHAMP, GRACE, and GRACE-FO: - + - ``CH_OPER_TEC_TMS_2F`` - ``GR_OPER_TECxTMS_2F`` - ``GF_OPER_TECxTMS_2F`` From c1ea073d4fe8b7447e148ea56807bd89f8fc6b9a Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Fri, 28 Mar 2025 19:32:51 +0000 Subject: [PATCH 3/8] Add link to query builder dashboard --- docs/available_parameters.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index 52fb2b0..7ce2d30 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -5,7 +5,11 @@ Available parameters for Swarm .. tip:: - Did you know? The *VirES for Swarm* service provides data not only from Swarm but also INTERMAGNET ground observatories (search below for ``AUX_OBS``), and recalibrated platform magnetometer data from selected LEO missions (search below for ``MAG_``). + Try the new `Query builder interactive tool `_ to explore the available parameters and create your own queries. This is a great way to get started with the data and see what is available. + +.. tip:: + + Did you know? The *VirES for Swarm* service provides data not only from Swarm but also INTERMAGNET ground observatories (search below for ``AUX_OBS``), and recalibrated platform magnetometer data from selected LEO missions (search below for ``MAG_``) and other "multi-mission" data. .. note:: From 171c28bfd0610ea792d031d310fb5c8fae94f70f Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Mon, 14 Apr 2025 17:27:58 +0100 Subject: [PATCH 4/8] Add header with links. --- docs/_templates/sections/header.html | 68 ++++++++++++++++++++++++++++ docs/available_parameters.rst | 24 +++++----- docs/index.rst | 12 +---- 3 files changed, 81 insertions(+), 23 deletions(-) create mode 100644 docs/_templates/sections/header.html diff --git a/docs/_templates/sections/header.html b/docs/_templates/sections/header.html new file mode 100644 index 0000000..6dd35ca --- /dev/null +++ b/docs/_templates/sections/header.html @@ -0,0 +1,68 @@ +
+ +
+ VirES for Swarm + Swarm VRE + Swarm Notebooks + SwarmPAL +
+
+ VirES for Aeolus + Aeolus VRE + Aeolus Notebooks +
+
+ + diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index 7ce2d30..9e34df0 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -5,15 +5,23 @@ Available parameters for Swarm .. tip:: - Try the new `Query builder interactive tool `_ to explore the available parameters and create your own queries. This is a great way to get started with the data and see what is available. + There are several ways to discover and learn more about the available data and models: -.. tip:: + - Try the new `Query builder interactive dashboard`_ to explore the catalogue and generate your own viresclient queries + - `Swarm Handbook`_: scentific metadata and related links for each product + - `Swarm Notebooks`_: a collection of Jupyter notebooks providing recipes to help use the data + +.. _`Query builder interactive dashboard`: https://dev.swarmdisc.org/dashboards/ + +.. _`Swarm Handbook`: https://swarmhandbook.earth.esa.int/catalogue/index - Did you know? The *VirES for Swarm* service provides data not only from Swarm but also INTERMAGNET ground observatories (search below for ``AUX_OBS``), and recalibrated platform magnetometer data from selected LEO missions (search below for ``MAG_``) and other "multi-mission" data. +.. _`Swarm Notebooks`: https://notebooks.vires.services/notebooks/02b__viresclient-available-data .. note:: - | `See also: Jupyter notebook about data and model availability `_ - check out the other demo notebooks there too. + Did you know? The *VirES for Swarm* service provides data not only from Swarm but also INTERMAGNET ground observatories (search below for ``AUX_OBS``), recalibrated platform magnetometer data from selected LEO missions (search below for ``MAG_``), and other "multi-mission" data such as total electron content (TEC), electron densities, temperatures, and their gradients. These are derived from spacecraft such as GOCE, CryoSat, GRACE, GRACE-FO, and more. + +---- You can check which parameters are available with: @@ -31,14 +39,6 @@ The available measurements are segregated according to the "collection" (essenti ---- -See the `Swarm Data Handbook`_ for details about the products and `Swarm Product Demos`_ (Jupyter notebooks) for basic recipes to get started. - -.. _`Swarm Data Handbook`: https://earth.esa.int/eogateway/missions/swarm/product-data-handbook - -.. _`Swarm Product Demos`: https://notebooks.vires.services/notebooks/03a1_demo-magx_lr_1b - ----- - ``collections`` --------------- diff --git a/docs/index.rst b/docs/index.rst index 83f0f0c..1649163 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,20 +3,10 @@ Introduction .. include:: ../README.rst -.. toctree:: - :hidden: - :caption: Virtual Research Environments - - VirES for Swarm - Swarm Notebooks - VirES for Aeolus - Aeolus Notebooks - - .. toctree:: :hidden: :maxdepth: 2 - :caption: Information on viresclient + :caption: viresclient Documentation self installation From 728ee9041e799d9eb8cc32007b517e4b89311aad Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Mon, 14 Apr 2025 17:41:00 +0100 Subject: [PATCH 5/8] Refer to "JupyterHub" instead of VRE in the header links --- docs/_templates/sections/header.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_templates/sections/header.html b/docs/_templates/sections/header.html index 6dd35ca..99a122b 100644 --- a/docs/_templates/sections/header.html +++ b/docs/_templates/sections/header.html @@ -4,13 +4,13 @@
VirES for Swarm - Swarm VRE + Swarm JupyterHub Swarm Notebooks SwarmPAL
VirES for Aeolus - Aeolus VRE + Aeolus JupyterHub Aeolus Notebooks
From 6699306f669793e018f6535e58e941d7148e2cf9 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Mon, 14 Apr 2025 18:27:18 +0100 Subject: [PATCH 6/8] tweak --- docs/_templates/sections/header.html | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/_templates/sections/header.html b/docs/_templates/sections/header.html index 99a122b..30a84f1 100644 --- a/docs/_templates/sections/header.html +++ b/docs/_templates/sections/header.html @@ -3,15 +3,16 @@ viresclient
- VirES for Swarm - Swarm JupyterHub - Swarm Notebooks - SwarmPAL + Swarm Notebooks + SwarmPAL + VirES for Swarm ↗ + Swarm JupyterHub ↗
+
- VirES for Aeolus - Aeolus JupyterHub - Aeolus Notebooks + Aeolus Notebooks + VirES for Aeolus ↗ + Aeolus JupyterHub ↗
@@ -31,14 +32,14 @@ .custom-header-container .section { margin: 0 20px; text-align: center; - padding: 10px; + padding: 5px; border: 1px solid #888; border-radius: 5px; } .custom-header-container .link { - margin: 0 10px; - padding: 5px 10px; + margin: 0 5px; + padding: 5px 5px; text-decoration: none; color: white; } @@ -48,8 +49,8 @@ } .custom-header-container .link-selected { - margin: 0 10px; - padding: 5px 10px; + margin: 0 5px; + padding: 5px 5px; text-decoration: none; background-color: #ccc; color: black; From 186bcf5fac6fcff239ac9fc6d0a9d2ca25655aa7 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Mon, 14 Apr 2025 18:47:00 +0100 Subject: [PATCH 7/8] Tweak --- docs/_templates/sections/header.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_templates/sections/header.html b/docs/_templates/sections/header.html index 30a84f1..a019150 100644 --- a/docs/_templates/sections/header.html +++ b/docs/_templates/sections/header.html @@ -8,7 +8,7 @@ VirES for Swarm ↗ Swarm JupyterHub ↗ -
+
Aeolus Notebooks VirES for Aeolus ↗ @@ -22,7 +22,7 @@ flex-wrap: wrap; justify-content: center; align-items: center; - padding: 10px; + padding: 5px; background-color: #555; border-top: 1px solid #ddd; width: 100%; From 294ef6bb05a5380107cddb20dfc95a64630eece6 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Mon, 14 Apr 2025 18:52:39 +0100 Subject: [PATCH 8/8] Tweak --- docs/_templates/sections/header.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_templates/sections/header.html b/docs/_templates/sections/header.html index a019150..4189088 100644 --- a/docs/_templates/sections/header.html +++ b/docs/_templates/sections/header.html @@ -5,14 +5,14 @@
Swarm Notebooks SwarmPAL - VirES for Swarm ↗ - Swarm JupyterHub ↗ + VirES for Swarm↗ + Swarm JupyterHub↗
Aeolus Notebooks - VirES for Aeolus ↗ - Aeolus JupyterHub ↗ + VirES for Aeolus↗ + Aeolus JupyterHub↗
@@ -23,7 +23,7 @@ justify-content: center; align-items: center; padding: 5px; - background-color: #555; + background-color: #616161; border-top: 1px solid #ddd; width: 100%; color: white;