Skip to content

Commit 2041995

Browse files
smitharasmithara
authored
Update documentation build and changelog (#127)
* Update documentation build and changelog * Add link to query builder dashboard * Add header with links.
1 parent 9d1cfe0 commit 2041995

File tree

7 files changed

+118
-29
lines changed

7 files changed

+118
-29
lines changed

‎.readthedocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ version: 2
77

88
# Set the OS, Python version and other tools you might need
99
build:
10-
os: ubuntu-22.04
10+
os: ubuntu-24.04
1111
tools:
12-
python: "3.8"
12+
python: "3.12"
1313

1414
# Build documentation in the docs/ directory with Sphinx
1515
sphinx:

‎docs/_templates/sections/header.html

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<div class="custom-header-container">
2+
<div>
3+
<a href="" class="link-selected">viresclient</a>
4+
</div>
5+
<div class="section">
6+
<a href="https://notebooks.vires.services" class="link">Swarm Notebooks</a>
7+
<a href="https://swarmpal.readthedocs.io" class="link">SwarmPAL</a>
8+
<a href="https://vires.services" target="_blank" class="link">VirES for Swarm↗</a>
9+
<a href="https://vre.vires.services" target="_blank" class="link">Swarm JupyterHub↗</a>
10+
</div>
11+
<div style="width: 100%; height: 5px;"></div>
12+
<div class="section">
13+
<a href="https://notebooks.aeolus.services" class="link">Aeolus Notebooks</a>
14+
<a href="https://aeolus.services" target="_blank" class="link">VirES for Aeolus↗</a>
15+
<a href="https://vre.aeolus.services" target="_blank" class="link">Aeolus JupyterHub↗</a>
16+
</div>
17+
</div>
18+
19+
<style>
20+
.custom-header-container {
21+
display: flex;
22+
flex-wrap: wrap;
23+
justify-content: center;
24+
align-items: center;
25+
padding: 5px;
26+
background-color: #616161;
27+
border-top: 1px solid #ddd;
28+
width: 100%;
29+
color: white;
30+
}
31+
32+
.custom-header-container .section {
33+
margin: 0 20px;
34+
text-align: center;
35+
padding: 5px;
36+
border: 1px solid #888;
37+
border-radius: 5px;
38+
}
39+
40+
.custom-header-container .link {
41+
margin: 0 5px;
42+
padding: 5px 5px;
43+
text-decoration: none;
44+
color: white;
45+
}
46+
47+
.custom-header-container .link:hover {
48+
color: #1e90ff !important;
49+
}
50+
51+
.custom-header-container .link-selected {
52+
margin: 0 5px;
53+
padding: 5px 5px;
54+
text-decoration: none;
55+
background-color: #ccc;
56+
color: black;
57+
border-radius: 5px;
58+
}
59+
60+
@media (max-width: 600px) {
61+
.custom-header-container {
62+
flex-direction: column; /* Stack sections vertically on small screens */
63+
}
64+
65+
.custom-header-container .section {
66+
width: 100%; /* Full width for sections */
67+
}
68+
}
69+
</style>

‎docs/available_parameters.rst

+15-10
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,23 @@ Available parameters for Swarm
55

66
.. tip::
77

8-
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_``).
8+
There are several ways to discover and learn more about the available data and models:
9+
10+
- Try the new `Query builder interactive dashboard`_ to explore the catalogue and generate your own viresclient queries
11+
- `Swarm Handbook`_: scentific metadata and related links for each product
12+
- `Swarm Notebooks`_: a collection of Jupyter notebooks providing recipes to help use the data
13+
14+
.. _`Query builder interactive dashboard`: https://dev.swarmdisc.org/dashboards/
15+
16+
.. _`Swarm Handbook`: https://swarmhandbook.earth.esa.int/catalogue/index
17+
18+
.. _`Swarm Notebooks`: https://notebooks.vires.services/notebooks/02b__viresclient-available-data
919

1020
.. note::
1121

12-
| `See also: Jupyter notebook about data and model availability <https://notebooks.vires.services/notebooks/02b__viresclient-available-data>`_ - check out the other demo notebooks there too.
22+
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.
23+
24+
----
1325

1426
You can check which parameters are available with:
1527

@@ -27,14 +39,6 @@ The available measurements are segregated according to the "collection" (essenti
2739

2840
----
2941

30-
See the `Swarm Data Handbook`_ for details about the products and `Swarm Product Demos`_ (Jupyter notebooks) for basic recipes to get started.
31-
32-
.. _`Swarm Data Handbook`: https://earth.esa.int/eogateway/missions/swarm/product-data-handbook
33-
34-
.. _`Swarm Product Demos`: https://notebooks.vires.services/notebooks/03a1_demo-magx_lr_1b
35-
36-
----
37-
3842
``collections``
3943
---------------
4044

@@ -123,6 +127,7 @@ SW_OPER_TIX_TMS_2F TIX_TMS
123127
============================== ================
124128

125129
The `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ provides products for TEC and Ne derived from CHAMP, GRACE, and GRACE-FO:
130+
126131
============================== ================
127132
Collection full name Collection type
128133
============================== ================

‎docs/index.rst

+1-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,10 @@ Introduction
33

44
.. include:: ../README.rst
55

6-
.. toctree::
7-
:hidden:
8-
:caption: Virtual Research Environments
9-
10-
VirES for Swarm <https://vires.services>
11-
Swarm Notebooks <https://notebooks.vires.services>
12-
VirES for Aeolus <https://aeolus.services>
13-
Aeolus Notebooks <https://notebooks.aeolus.services>
14-
15-
166
.. toctree::
177
:hidden:
188
:maxdepth: 2
19-
:caption: Information on viresclient
9+
:caption: viresclient Documentation
2010

2111
self
2212
installation

‎docs/release_notes.rst

+25
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,31 @@ Release notes
44
Change log
55
----------
66

7+
Changes from 0.12.3 to 0.13.0
8+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9+
10+
- Added support for new products:
11+
12+
- Swarm `ULF wave project <https://earth.esa.int/eogateway/activities/swarm-ulf-ionosphere>`_:
13+
14+
- ``SW_OPER_ULFxMAG_2F``
15+
- ``SW_OPER_PC1xMAG_2F``
16+
17+
- `MIGRAS project <https://earth.esa.int/eogateway/activities/migras>`_ providing ionospheric gradients of TEC and electron density:
18+
19+
- ``SW_OPER_NIX_TMS_2F``
20+
- ``SW_OPER_TIX_TMS_2F``
21+
22+
- `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ providing TEC and electron density derived from CHAMP, GRACE, and GRACE-FO:
23+
24+
- ``CH_OPER_TEC_TMS_2F``
25+
- ``GR_OPER_TECxTMS_2F``
26+
- ``GF_OPER_TECxTMS_2F``
27+
- ``GR_OPER_NE__KBR_2F``
28+
- ``GF_OPER_NE__KBR_2F``
29+
30+
- Added :py:meth:`viresclient.SwarmRequest.get_collection_info` to query collection details from server (e.g. time extent)
31+
732
Changes from 0.12.2 to 0.12.3
833
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
934

‎noxfile.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ def lint(session):
1010
session.run("pre-commit", "run", "--all-files", *session.posargs)
1111

1212

13-
@nox.session(python=["3.6", "3.7", "3.8", "3.9", "3.10"])
13+
@nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"])
1414
def tests(session):
1515
session.install(".")
1616
session.install("pytest")
1717
session.run("pytest")
1818

1919

20-
@nox.session
20+
@nox.session(python="3.12")
2121
def docs(session: nox.Session) -> None:
2222
"""
2323
Build the docs. Pass "serve" to serve.

‎pyproject.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ dev = [
5757
"nox >=2022",
5858
]
5959
docs = [
60-
"Sphinx == 4.5.0",
61-
"sphinx-book-theme == 0.3.3",
62-
"sphinx_copybutton == 0.5.0",
63-
"sphinx-tabs == 3.4.0",
60+
"Sphinx == 8.2",
61+
"sphinx-book-theme == 1.1.4",
62+
"sphinx-copybutton == 0.5.2",
63+
"sphinx-tabs == 3.4.7",
6464
]
6565

6666
[project.scripts]

0 commit comments

Comments
 (0)