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/_templates/sections/header.html b/docs/_templates/sections/header.html new file mode 100644 index 0000000..4189088 --- /dev/null +++ b/docs/_templates/sections/header.html @@ -0,0 +1,69 @@ +
+
+ viresclient +
+
+ Swarm Notebooks + SwarmPAL + VirES for Swarm↗ + Swarm JupyterHub↗ +
+
+
+ Aeolus Notebooks + VirES for Aeolus↗ + Aeolus JupyterHub↗ +
+
+ + diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index e576d19..9e34df0 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -5,11 +5,23 @@ 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_``). + There are several ways to discover and learn more about the available data and models: + + - 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 + +.. _`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: @@ -27,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`` --------------- @@ -123,6 +127,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/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 diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 12c4904..4d1942a 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]