Simplify the architecture diagram

holoviz / hvplot

A high-level plotting API for pandas, dask, xarray, and networkx built on HoloViews

https://hvplot.holoviz.org

BSD 3-Clause "New" or "Revised" License

1.13k stars 109 forks source link

Simplify the architecture diagram #859

Open MarcSkovMadsen opened 2 years ago

MarcSkovMadsen commented 2 years ago

I like the "architecture" diagram of hvPlot shown at the top of the home page

But I think it could be simplified and cleaned up to community more clearly and be more easy to "speak to".

change the 3 plotting arrows to one
Align the arrows on the same horizontal line
Align Holoviews and Datashader on the same vertical line
Put the plotting backends into a dotted circle like the data libraries or remove the circles.
Align to text headers on the same vertical line and consider if the number of characters could be meaningfully reduced.
Consider if in any way there is room for indicating the .interactive() api as well.
Add Streamz to the data sources
Consider changing Dask, Geopandas, Pandas order to Pandas, Dask, GeoPandas to see the most well known data sources first.

The below quickly indicates the changes

MarcSkovMadsen commented 2 years ago

I tried it out on social media. The dimensions are not good as its too wide and gets cut off.

To simplify even further HoloViews and Datashader could be left out depending on the context.

philippjfr commented 2 years ago

To simplify even further HoloViews and Datashader could be left out depending on the context.

Or made much smaller as a little inset on the arrow leading from hvPlot to the plotting backends.

MarcSkovMadsen commented 2 years ago

The existing "architecture" diagram is a SVG @jbednar . Is that a requirement? Are there other requirements or use cases it needs to meet?

MarcSkovMadsen commented 2 years ago

Another Experiment

Panel and Geoviews are missing from the original diagram
With .interactive() you can output to anything (Panel supports), so I added the Python logo.
Also too wide for social media.

jbednar commented 2 years ago

The existing "architecture" diagram is a SVG @jbednar . Is that a requirement? Are there other requirements or use cases it needs to meet?

The diagram is an SVG so that we can remix and edit it without losing resolution. E.g. if we want to make some of those icons bigger and others smaller, we can do that without having to track down the original logo pngs. But it's totally ok to store the SVG in the source tree and actually deliver a PNG in the document; no problem.