From 79e9f83c8cd176751a5196fd9828572e45f8fe45 Mon Sep 17 00:00:00 2001 From: Tom Date: Thu, 24 Apr 2025 10:54:11 +0100 Subject: [PATCH] Add note about live server to docs --- docs/conf.py | 4 ++++ docs/quickstart.md | 6 +++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 4002e3b..a911ec2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,3 +33,7 @@ source_suffix = { html_theme = "sphinx_rtd_theme" html_static_path = ["_static"] + +myst_enable_extensions = [ + "attrs_inline", +] diff --git a/docs/quickstart.md b/docs/quickstart.md index 9f742f3..b38ff1c 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -8,7 +8,7 @@ jupytext: --- # Quickstart -First install qubed with `pip install qubed`. Now, let's dive in with a real world dataset from the [Climate DT](https://destine.ecmwf.int/climate-change-adaptation-digital-twin-climate-dt/). We'll pull a prebuild qube from github and render it in it's default HTML representation. +First install qubed with `pip install qubed`. Now, let's dive in with a real world dataset from the [Climate DT](https://destine.ecmwf.int/climate-change-adaptation-digital-twin-climate-dt/). We'll pull a prebuilt qube from github and render it in it's default HTML representation. ```{code-cell} python3 import requests @@ -19,6 +19,10 @@ climate_dt.html(depth=1) Click the arrows to expand and drill down deeper into the data. +```{note} +There is currently a simple Qube web browser hosted [here](https://qubed.lumi.apps.dte.destination-earth.eu/). Browse that and copy the 'Example Qube Code' to download a Qube representing the selection at that point. You'll get something like `Qube.from_json(requests.get("https://qubed.lumi.apps.dte.destination-earth.eu/api/v1/select/climate-dt/?").json())`{l=python} +``` + Fundamentally a Qube represents a set identifiers which are a set of key value pairs, here's the one leaf in the Climate DT dataset: ```{code-cell} python3