Skip to content
Snippets Groups Projects
Commit 04565f7b authored by Joseph Weston's avatar Joseph Weston
Browse files

update plot docstring to disallow arrays with kwant.Builder

parent a8d174c7
No related branches found
No related tags found
No related merge requests found
...@@ -735,17 +735,21 @@ def plot(sys, num_lead_cells=2, unit='nn', ...@@ -735,17 +735,21 @@ def plot(sys, num_lead_cells=2, unit='nn',
symbols specifications (only for kwant.system.FiniteSystem). symbols specifications (only for kwant.system.FiniteSystem).
site_size : number, function, array, or `None` site_size : number, function, array, or `None`
Relative (linear) size of the site symbol. Relative (linear) size of the site symbol.
An array may not be used when 'syst' is a kwant.Builder.
site_color : ``matplotlib`` color description, function, array, or `None` site_color : ``matplotlib`` color description, function, array, or `None`
A color used for plotting a site in the system. If a colormap is used, A color used for plotting a site in the system. If a colormap is used,
it should be a function returning single floats or a one-dimensional it should be a function returning single floats or a one-dimensional
array of floats. By default sites are colored by their site family, array of floats. By default sites are colored by their site family,
using the current matplotlib color cycle. using the current matplotlib color cycle.
An array of colors may not be used when 'syst' is a kwant.Builder.
site_edgecolor : ``matplotlib`` color description, function, array, or `None` site_edgecolor : ``matplotlib`` color description, function, array, or `None`
Color used for plotting the edges of the site symbols. Only Color used for plotting the edges of the site symbols. Only
valid matplotlib color descriptions are allowed (and no valid matplotlib color descriptions are allowed (and no
combination of floats and colormap as for site_color). combination of floats and colormap as for site_color).
An array of colors may not be used when 'syst' is a kwant.Builder.
site_lw : number, function, array, or `None` site_lw : number, function, array, or `None`
Linewidth of the site symbol edges. Linewidth of the site symbol edges.
An array may not be used when 'syst' is a kwant.Builder.
hop_color : ``matplotlib`` color description or a function hop_color : ``matplotlib`` color description or a function
Same as `site_color`, but for hoppings. A function is passed two sites Same as `site_color`, but for hoppings. A function is passed two sites
in this case. (arrays are not allowed in this case). in this case. (arrays are not allowed in this case).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment