Skip to content

Update documentation build and changelog #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
69 changes: 69 additions & 0 deletions docs/_templates/sections/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<div class="custom-header-container">
<div>
<a href="" class="link-selected">viresclient</a>
</div>
<div class="section">
<a href="https://notebooks.vires.services" class="link">Swarm Notebooks</a>
<a href="https://swarmpal.readthedocs.io" class="link">SwarmPAL</a>
<a href="https://vires.services" target="_blank" class="link">VirES for Swarm↗</a>
<a href="https://vre.vires.services" target="_blank" class="link">Swarm JupyterHub↗</a>
</div>
<div style="width: 100%; height: 5px;"></div>
<div class="section">
<a href="https://notebooks.aeolus.services" class="link">Aeolus Notebooks</a>
<a href="https://aeolus.services" target="_blank" class="link">VirES for Aeolus↗</a>
<a href="https://vre.aeolus.services" target="_blank" class="link">Aeolus JupyterHub↗</a>
</div>
</div>

<style>
.custom-header-container {
display: flex;
flex-wrap: wrap;
justify-content: center;
align-items: center;
padding: 5px;
background-color: #616161;
border-top: 1px solid #ddd;
width: 100%;
color: white;
}

.custom-header-container .section {
margin: 0 20px;
text-align: center;
padding: 5px;
border: 1px solid #888;
border-radius: 5px;
}

.custom-header-container .link {
margin: 0 5px;
padding: 5px 5px;
text-decoration: none;
color: white;
}

.custom-header-container .link:hover {
color: #1e90ff !important;
}

.custom-header-container .link-selected {
margin: 0 5px;
padding: 5px 5px;
text-decoration: none;
background-color: #ccc;
color: black;
border-radius: 5px;
}

@media (max-width: 600px) {
.custom-header-container {
flex-direction: column; /* Stack sections vertically on small screens */
}

.custom-header-container .section {
width: 100%; /* Full width for sections */
}
}
</style>
25 changes: 15 additions & 10 deletions docs/available_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://notebooks.vires.services/notebooks/02b__viresclient-available-data>`_ - 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:

Expand All @@ -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``
---------------

Expand Down Expand Up @@ -123,6 +127,7 @@ SW_OPER_TIX_TMS_2F TIX_TMS
============================== ================

The `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ provides products for TEC and Ne derived from CHAMP, GRACE, and GRACE-FO:

============================== ================
Collection full name Collection type
============================== ================
Expand Down
12 changes: 1 addition & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,10 @@ Introduction

.. include:: ../README.rst

.. toctree::
:hidden:
:caption: Virtual Research Environments

VirES for Swarm <https://vires.services>
Swarm Notebooks <https://notebooks.vires.services>
VirES for Aeolus <https://aeolus.services>
Aeolus Notebooks <https://notebooks.aeolus.services>


.. toctree::
:hidden:
:maxdepth: 2
:caption: Information on viresclient
:caption: viresclient Documentation

self
installation
Expand Down
25 changes: 25 additions & 0 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://earth.esa.int/eogateway/activities/swarm-ulf-ionosphere>`_:

- ``SW_OPER_ULFxMAG_2F``
- ``SW_OPER_PC1xMAG_2F``

- `MIGRAS project <https://earth.esa.int/eogateway/activities/migras>`_ providing ionospheric gradients of TEC and electron density:

- ``SW_OPER_NIX_TMS_2F``
- ``SW_OPER_TIX_TMS_2F``

- `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
4 changes: 2 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading