From ff9c8fec1fc58bc9febc111dc9acea08d53a4fcd Mon Sep 17 00:00:00 2001 From: jgostick Date: Wed, 21 Jun 2023 20:48:14 +0900 Subject: [PATCH] updated docstring in the size_by arg to point out that the size is marker area --- openpnm/visualization/_plottools.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/openpnm/visualization/_plottools.py b/openpnm/visualization/_plottools.py index c90d76f7c1..15e2ef165b 100644 --- a/openpnm/visualization/_plottools.py +++ b/openpnm/visualization/_plottools.py @@ -208,7 +208,9 @@ def plot_coordinates(network, well as throat connections from ``plot_connections``. size_by : str or array_like An ndarray of pore values (e.g. alg['pore.concentration']). These - values are normalized by scaled by ``markersize``. + values are normalized by scaled by ``markersize``. Note that this controls + the marker *area*, so if you want the markers to be proportional to diameter + you should do `size_by=net['pore.diameter']**2`. color_by : str or array_like An ndarray of pore values (e.g. alg['pore.concentration']). cmap : str or cmap object