Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
K
kwant
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Joseph Weston
kwant
Commits
04565f7b
Commit
04565f7b
authored
5 years ago
by
Joseph Weston
Browse files
Options
Downloads
Patches
Plain Diff
update plot docstring to disallow arrays with kwant.Builder
parent
a8d174c7
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
kwant/plotter.py
+4
-0
4 additions, 0 deletions
kwant/plotter.py
with
4 additions
and
0 deletions
kwant/plotter.py
+
4
−
0
View file @
04565f7b
...
@@ -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).
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment