Add New Gallery Examples #1603

Azaya89 · 2025-06-20T18:22:45Z

Azaya89 · 2025-06-20T18:27:47Z

Still a WIP but here's the current implementation with two sub-sections added:

maximlt · 2025-06-24T16:52:56Z

doc/gallery/thumbnails/area_time_series.png

You may have noticed that we don't store the thumbnails of the current gallery in the repo but on S3 (see the conf.py that links to https://assets.holoviz.org/hvplot/thumbnails). We'll do the same for these new thumbnails.

I'm also not a big fan of generating squared thumbnails by distorting them, they don't look so good, don't they? Minor thing but just wanted to mention it.

I'm all for storing the thumbnails on S3, but the thumbnails do look OK to me in the built docs though. I guess you may look at it differently when you see it in the cards?

the thumbnails do look OK to me in the built docs though

This is where I politely disagree :)

maximlt · 2025-07-14T08:49:22Z

I haven't checked but I thought that one nice goal to achieve with the gallery would be to have at least one example per plotting method. I.e. all the plotting methods referenced on this page https://hvplot.holoviz.org/ref/api/index.html (excluding NetworkX method for now).

Azaya89 · 2025-07-14T10:51:34Z

I haven't checked but I thought that one nice goal to achieve with the gallery would be to have at least one example per plotting method. I.e. all the plotting methods referenced on this page https://hvplot.holoviz.org/ref/api/index.html (excluding NetworkX method for now).

Sounds like a good idea.

maximlt · 2025-07-14T12:36:59Z

The idea being that would be a good place for users to find all the types of plots hvPlot can make, and from these examples they can then easily find their reference API for more information.

Azaya89 · 2025-07-14T16:23:34Z

The idea being that would be a good place for users to find all the types of plots hvPlot can make, and from these examples they can then easily find their reference API for more information.

Makes sense. I'll try to add a few more as I can.

* Add coastline * Update doc/gallery/geospatial/geopoints.ipynb Co-authored-by: Azaya <[email protected]> * clean nb * change thumbnail image --------- Co-authored-by: Azaya <[email protected]> Co-authored-by: Isaiah Akorita <[email protected]>

maximlt

Leaving various comments made while reviewing the changes made in this PR. Not expecting any change as I'm making them while I go. But please @Azaya89 have a look at them and answer the questions when you can.

maximlt · 2025-08-19T14:57:45Z

pixi.toml

 name = "hvplot"
 channels = ["pyviz/label/dev",  "conda-forge"]
 platforms = ["linux-64", "osx-arm64", "osx-64", "win-64"]
+preview = ["pixi-build"] # temp until 0.1.4 release


Why is this needed?

This was to enable pixi download the dev version of hvsampledata (0.1.4a2) until 0.1.4 is fully released. I think it can be removed now.

Sounds strange because we depend on the pyviz/label/dev channel and push hvsampledata dev releases on this channel. I've removed that change.

[feature.doc] channels = [ # To get dev HoloViews, not always needed. "pyviz/label/dev", # To get dev nbsite, not always needed. "pyviz/label/tooling_dev", "conda-forge" ]

maximlt · 2025-08-19T15:02:51Z

doc/gallery/index.md

+(basic-charts)=
+## Basic Charts
+
+::::{grid} 1 2 2 4


IIRC you said you adopted the same approach as Panel. Panel uses a mix of approaches, it uses nbsite's gallery extension for the Component Gallery (https://github.com/holoviz/panel/blob/13419c763105fadc563bc8a6263d39aea33e6041/doc/conf.py#L139) and this custom sphinx-design grid for other pages that include a gallery/grid.

I'm quite tempted to use nbsite's gallery here as it should make the contributor experience a little better.

if it makes things better I'm all for it.

Yes I've switched to the nbsite gallery implementation. Made some changes to nbsite to customize the design a bit and facilitate a few things.

maximlt · 2025-08-19T18:49:39Z

doc/conf.py

 # cell execution timeout in seconds (-1 to ignore, 30 by default)
 nb_execution_timeout = 240

-if os.getenv('HVPLOT_REFERENCE_GALLERY') not in ('False', 'false', '0'):


When we remove pages, we should always add redirect links. In this case, we'll need to keep two sets of redirects:

links from reference/pandas/foo to reference/tabular/foo

links from reference/tabular/foo to whatever is the best replacement for this now (plotting API page I think)

maximlt · 2025-08-19T18:50:43Z

doc/gallery/advanced/index.md

+    <meta http-equiv='refresh' content='0; URL=../index.html#advanced'>
+</head>
+
+# Advanced Plots


I'll see if I can find a better name for this category. Otherwise "Advanced" will end up being a collection of random examples.

maximlt · 2025-08-19T18:51:10Z

doc/gallery/categorical/category_bar.ipynb

+    "# Category Breakdown Bar Chart\n",
+    "\n",
+    "A grouped bar chart that shows how each species of penguin is distributed across different islands.  \n",
+    "This example uses the `penguins` dataset from hvplot's built-in sample data."


The sample datasets aren't really built-in.

Will modify

Already done :)

maximlt · 2025-08-27T06:39:33Z

doc/gallery/multi-dimensional/groupby.ipynb

+   "metadata": {},
+   "source": [
+    ":::{note}\n",
+    "The `groupby` widget interactivity is only supported in the **Bokeh** backend  \n",


Not true, this is supported by all the backends.

My assumption was that all interactivity options don't work in the mpl backend. My bad...

HoloViews originally supported Matplotlib only and had already these widgets to drill down a multi-dimensional dataset https://proceedings.scipy.org/articles/Majora-7b98e3ed-00a.pdf.

maximlt · 2025-08-27T06:41:36Z

doc/gallery/multi-dimensional/groupby.ipynb

+   "source": [
+    ":::{note}\n",
+    "The `groupby` widget interactivity is only supported in the **Bokeh** backend  \n",
+    "and requires a **live Python environment** (e.g. Jupyter Notebook, JupyterLab, or Panel app).\n",


In the docs we use the dynamic=False trick to provide a better user experience.

Yeah but IIRC, I thought we wanted to stop doing that so as not to confuse users since we don't really explain what dynamic=False does in the plot?

True I would like at some point to have a way to deal with that in a better way, with a custom sphinx extension that does the right thing. As it doesn't exist yet so let's stick to dynamic=False :)

maximlt · 2025-08-27T08:21:30Z

doc/gallery/multi-dimensional/quadmesh.ipynb

+   "source": [
+    "import hvplot.xarray  # noqa\n",
+    "\n",
+    "ds = hvplot.sampledata.air_temperature(\"xarray\").sel(time=\"2014-02-25 12:00\")\n",


I don't think using quadmesh on a regular grid like this dataset brings much vs. image?

maximlt · 2025-08-27T08:24:31Z

doc/gallery/time-series/dual_axis_timeseries.ipynb

+   "metadata": {},
+   "source": [
+    ":::{note}\n",
+    "The `multi_y=True` option enables dual y‑axes **only for the Bokeh backend**. When used with Matplotlib, it falls back to a single shared axis and issues a warning indicating multi‑axis support is unavailable. See [Customizing Plots](https://holoviews.org/user_guide/Customizing_Plots.html#twin-axes).\n",


Nice to add this example! But the multi_y option should be documented as a HoloViews feature, the example doesn't make that clear.

maximlt · 2025-08-27T10:06:32Z

doc/gallery/interactivity/index.md

+Penguins App <penguins_app>
+Sine Wave <sine_curve>


Penguins App and Sine Wave are very similar: 2 widgets, a plot function, and pn.bind.

maximlt · 2025-08-27T21:51:41Z

TODO:

Make sure redirect links are OK
Add missing examples, see Add New Gallery Examples #1603 (comment)
Integrate Add bar value labels to gallery examples #1614
Integrate Add downsampling large vectorfield example #1620
One example downloads a pretty large dataset (earthquakes), I'd like to skip running it when we run the examples test suite normally as it might be long, but I'd like it to run on scheduled runs.
Release nbsite with gallery improvements

maximlt

Thanks @Azaya89 !

Azaya89 added 7 commits June 18, 2025 13:41

create new gallery dir

dc98984

add basic charts content

71c9c61

add thumbnails

1ad7e1b

update grid

9c28e69

move thumbnail dir

81bfa7f

add time series examples

25e3d0e

add timeseries index toctree

6de90af

maximlt added the NF SDG 2025 NumFocus Software Development Grant 2025 label Jun 21, 2025

Azaya89 added 2 commits June 24, 2025 09:54

Merge branch 'main' into gallery-examples

809d26d

add categorical examples

98127a7

maximlt reviewed Jun 24, 2025

View reviewed changes

Azaya89 added 8 commits June 26, 2025 12:49

add statistical examples

c97c03a

move violin and boxplot to statistical category

1930b62

add geospatial examples

cd95a46

Merge branch 'main' into gallery-examples

8a237fc

add multi-dimension examples

6f2f58e

add interactivity examples

318dbdc

add advanced examples

dbfa534

add redirect link

8b90ec1

rename advanced section

22d7e83

Azaya89 added 2 commits July 14, 2025 17:14

remove bold

34e84e5

reformat images

58936b2

Azaya89 added 3 commits July 15, 2025 14:40

re-arrange sections

ef340df

Merge branch 'main' into gallery-examples

5828af8

add more examples

bdc644b

ahuang11 and others added 4 commits July 18, 2025 13:03

Merge branch 'main' into gallery-examples

5b0fbf7

add card and thumbnail image

0322203

add note to geopoints notebook

75f9ac6

Azaya89 marked this pull request as ready for review July 18, 2025 17:52

Azaya89 requested a review from maximlt July 18, 2025 17:52

Azaya89 and others added 9 commits July 30, 2025 15:10

use us_states dataset for polygon example

e3ac072

minor modif

761561b

Merge branch 'main' into gallery-examples

d027d7e

remove mpl example

5b37ae1

update to use new sampledata module

fe5df86

Merge branch 'main' into gallery-examples

78e9c2d

delete old gallery section

87e4b2f

remove all references to the old gallery section

7050b94

various updates

c5fa00b

maximlt reviewed Aug 27, 2025

View reviewed changes

maximlt and others added 10 commits August 28, 2025 11:13

re-add redirects and add new ones

5652df6

add missing plots

b15fb61

undo debug code

cc396c0

add horizontal bar with labels example

38a64a3

Add downsampling large vectorfield example (#1620)

b9d2f34

add annotations section

64661dc

exclude slow examples

cb93f9c

minor readme updates

6bbf620

bump nbsite

4d4b1e1

remove pixi preview

3672e32

maximlt approved these changes Aug 28, 2025

View reviewed changes

maximlt merged commit c41bb35 into main Aug 28, 2025
11 checks passed

maximlt deleted the gallery-examples branch August 28, 2025 20:10

Uh oh!

Add New Gallery Examples #1603

Add New Gallery Examples #1603

Uh oh!

Conversation

Azaya89 commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Azaya89 commented Jun 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maximlt commented Jul 14, 2025

Uh oh!

Azaya89 commented Jul 14, 2025

Uh oh!

maximlt commented Jul 14, 2025

Uh oh!

Azaya89 commented Jul 14, 2025

Uh oh!

maximlt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maximlt commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maximlt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Azaya89 commented Jun 20, 2025 •

edited

Loading

maximlt commented Aug 27, 2025 •

edited

Loading