circuit_visualize module¶
- class circuit_visualize.CircuitMovie(circuit: pyjjasim.josephson_circuit.Circuit, animate_interval=10, node_data=None, arrow_data=None, face_data=None, vortex_data=None, vortex_diameter=0.25, vortex_color=(0, 0, 0), anti_vortex_color=(0.8, 0.1, 0.2), vortex_alpha=1, vortex_label='', _vortex_range=None, show_grid=True, grid_width=1, grid_color=(0.4, 0.5, 0.6), grid_alpha=0.5, show_colorbar=True, show_legend=True, legend_width_fraction=0.2, show_axes=True, axis_position=(0.1, 0.1, 0.85, 0.85), arrow_width=0.005, arrow_scale=1, arrow_headwidth=3, arrow_headlength=3.5, arrow_headaxislength=3, arrow_minshaft=1, arrow_minlength=1, arrow_color=(0.15, 0.3, 0.8), arrow_alpha=1, arrow_label='', show_nodes=True, node_diameter=0.25, node_face_color=(1, 1, 1), node_edge_color=(0, 0, 0), nodes_as_voronoi=False, node_alpha=1, node_quantity_cmap=None, node_quantity_clim=None, node_quantity_alpha=1, node_quantity_logarithmic_colors=False, node_label='', face_quantity_cmap=None, face_quantity_clim=None, face_quantity_alpha=1, face_quantity_logarithmic_colors=False, face_label='', figsize=None, title='', fig=None)[source]¶
Animation of circuit where the quantities evolve over time.
- Allows one to show node quantities, arrow quantities, face quantities and vortices.
Node quantities are shown as colors on the nodes.
Arrow quantities are displayed at the junctions and the length of the arrows is proportional to the quantity value.
Face quantities are shown as colors on the faces.
Vortices are displayed by symbols (concentric rings, vorticity equals nr of rings, color shows sign).
Base class used by
circuit_visualize.TimeEvolutionMovie
, where one can specify what physical quantities to display in the circuit.- Parameters
- circuit
josephson_circuit.Circuit
Object representing circuit.
- animate_intervalscalar
Frame delay in ms.
- node_data=None(Nn, time_points) array or (Nn,) array or None
Data associated with nodes in circuit. Can be visualized as colors. If None, node data is not visualized. Time independent if shape (Nn,).
- arrow_data=None(Nj, time_points) array or (Nj,) array or None
Data associated with junctions in circuit. Can be visualized as arrows. where the length corresponds with the magnitude of the data. If None, arrow data is not visualized. Time independent if shape (Nj,).
- face_data=None(Nf, time_points) array or (Nf,) array or None
Data associated with faces in circuit. Can be visualized as colors. If None, face data is not visualized. Time independent if shape (Nf,).
- vortex_data=None(Nf, time_points) int array or (Nf,) int array or None
Integer data associated with faces in circuit. Can be visualized as circular symbols. The value of the data equals the number of concentric rings of the symbol. The color shows if it is + or -. If None, vortex data is not visualized. Time independent if shape (Nf,).
- vortex_diameter=0.25float
Diameter of vortex symbols.
- vortex_color=(0, 0, 0)color
Color of vortex symbols.
- anti_vortex_color=(0.8, 0.1, 0.2)color
Color of anti-vortex symbols, whose data is negative.
- vortex_alpha=1float
Transparency of vortex symbols.
- vortex_label=””str
Label given to vortex data in legend.
- show_grid=Truebool
Display a grid at the edges of the graph.
- grid_width=1float
Width of lines of grid.
- grid_color=(0.4, 0.5, 0.6)color
Color of grid.
- grid_alpha=0.5float
Transparency of grid.
- show_colorbar=Truebool
Show colorbar mapping face and/or node data to colors.
- show_legend=Truebool
Show legend which includes colormaps, explanation of vortex sybols and an arrow scale.
- legend_width_fraction=0.2float
Fraction of the width of the axes (as specified by axis_position) dedicated to the legend; if it is shown.
- show_axes=Truebool
If True, shows axes with the coordinates of the circuit.
- axis_position=(0.1, 0.1, 0.85, 0.85)array_like
Position of axis in figure (x0, y0, dx, dy, between 0 and 1)
- arrow_width=0.005float
Width of arrows.
- arrow_scale=1float
Scale-factor for arrows. (length of arrow = arrow_scale * arrow_data)
- arrow_headwidth=3float
Width of head of arrows. (see matplotlib.quiver)
- arrow_headlength=3.5float
Length of head of arrows. (see matplotlib.quiver)
- arrow_headaxislength=3float
Arrow property. (see matplotlib.quiver)
- arrow_minshaft=1float
Arrow property. (see matplotlib.quiver)
- arrow_minlength=1float
Arrow property. (see matplotlib.quiver)
- arrow_color=(0.15, 0.3, 0.8)color
Color of arrows.
- arrow_alpha=1float
Transparency of arrows.
- arrow_label=””str
Label given to arrow data in legend.
- show_nodes=Truebool
If True, nodes are displayed as circles.
- node_diameter=0.25float
Diameter of nodes.
- node_face_color=(1,1,1)color
Color of faces of nodes. Only used if there is no node data.
- node_edge_color=(0, 0, 0)color
Color of edge of nodes. Only used if there is no node data.
- nodes_as_voronoi=Falsebool
If True, node data is visualized as colors of faces of a voronoi diagram based on node coordinates rather than color of circles at node coordinates.
- node_alpha=1float
Transparency of nodes.
- node_quantity_cmap=Nonecolormap or None
Colormap for node_data.
- node_quantity_clim=None(float, float) or None
Color limits for node_data.
- node_quantity_alpha=1float
Transparency of colors used to represent node_data.
- node_quantity_logarithmic_colors=Falsebool
If True, node_data color-scale is logarithmic.
- node_label=””str
Label given to the node colormap.
- face_quantity_cmap=Nonecolormap or None
Volormap for face_data
- face_quantity_clim=None(float, float) or None
Color limits for face_data.
- face_quantity_alpha=1float
Transparency of colors used to represent face_data.
- face_quantity_logarithmic_colors=Falsebool
If True, face_data color-scale is logarithmic.
- face_label=””str
Label given to the face colormap.
- figsize=None(float, float) or None
Size of figure in inches.
- title=””str
Title given to figure.
- circuit
Methods
Return FuncAnimation handle.
get_arrow_data
()Get data visualized with arrows.
get_arrow_data_handles
()Get handle containing visualization of arrow_data.
get_axes_handle
()Returns main axes containing the visualization of the circuit.
get_colorbar1_handle
()Get handle of first (left) colorbar.
get_colorbar2_handle
()Get handle of second (right) colorbar.
get_face_data
()Get data visualized at faces with colors.
get_face_data_handle
()Get handle containing visualization of face_data.
get_figure_handle
()Returns figure handle.
get_grid_handle
()Get handle containing grid.
get_junction_data
()Get data visualized with junctions.
get_legend_axis_handle
()Get axis-handle containing the legend (with arrow-scale, vortex symbol legend and colormaps).
get_node_data
()Get data visualized at nodes.
get_node_data_handle
()Get handle containing visualization of node_data.
get_vortex_data
()Get integer data visualized at faces with symbols.
get_vortex_data_handles
()Get handles containing vortex symbols.
make
()Make circuit plot.
- class circuit_visualize.CircuitPlot(circuit: pyjjasim.josephson_circuit.Circuit, node_data=None, arrow_data=None, face_data=None, vortex_data=None, vortex_diameter=0.25, vortex_color=(0, 0, 0), anti_vortex_color=(0.8, 0.1, 0.2), vortex_alpha=1, vortex_label='', show_grid=True, grid_width=1, grid_color=(0.4, 0.5, 0.6), grid_alpha=0.5, show_colorbar=True, show_legend=True, legend_width_fraction=0.2, show_axes=True, axis_position=(0.1, 0.1, 0.85, 0.85), arrow_width=0.005, arrow_scale=1, arrow_headwidth=3, arrow_headlength=3.5, arrow_headaxislength=3, arrow_minshaft=1, arrow_minlength=1, arrow_color=(0.15, 0.3, 0.8), arrow_alpha=1, arrow_label='', show_nodes=True, node_diameter=0.25, node_face_color=(1, 1, 1), node_edge_color=(0, 0, 0), nodes_as_voronoi=False, node_alpha=1, node_quantity_cmap=None, node_quantity_clim=None, node_quantity_alpha=1, node_quantity_logarithmic_colors=False, node_label='', face_quantity_cmap=None, face_quantity_clim=None, face_quantity_alpha=1, face_quantity_logarithmic_colors=False, face_label='', figsize=None, title='', _vortex_range=None, fig=None)[source]¶
Plots a circuit configuration.
- Allows one to show node quantities, arrow quantities, face quantities and vortices.
Node quantities are shown as colors on the nodes.
Arrow quantities are displayed at the junctions and the length of the arrows is proportional to the quantity value.
Face quantities are shown as colors on the faces.
Vortices are displayed by symbols (concentric rings, vorticity equals nr of rings, color shows sign).
Base class used by
circuit_visualize.ConfigPlot
, where one can specify what physical quantities to display in the circuit.- Parameters
- circuit
josephson_circuit.Circuit
Object representing circuit.
- node_data=None(Nn,) array or None
Data associated with nodes in circuit. Can be visualized as colors. If None, node data is not visualized.
- arrow_data=None(Nj,) array or None
Data associated with junctions in circuit. Can be visualized as arrows. where the length corresponds with the magnitude of the data. If None, arrow data is not visualized.
- face_data=None(Nf,) array or None
Data associated with faces in circuit. Can be visualized as colors. If None, face data is not visualized.
- vortex_data=None(Nf,) int array or None
Integer data associated with faces in circuit. Can be visualized as circular symbols. The value of the data equals the number of concentric rings of the symbol. The color shows if it is + or -. If None, vortex data is not visualized.
- vortex_diameter=0.25float
Diameter of vortex symbols.
- vortex_color=(0, 0, 0)color
Color of vortex symbols.
- anti_vortex_color=(0.8, 0.1, 0.2)color
Color of anti-vortex symbols, whose data is negative.
- vortex_alpha=1float
Transparency of vortex symbols.
- vortex_label=””str
Label given to vortex data in legend.
- show_grid=Truebool
Display a grid at the edges of the graph.
- grid_width=1float
Width of lines of grid.
- grid_color=(0.4, 0.5, 0.6)color
Color of grid.
- grid_alpha=0.5float
Transparency of grid.
- show_colorbar=Truebool
Show colorbar mapping face and/or node data to colors.
- show_legend=Truebool
Show legend which includes colormaps, explanation of vortex sybols and an arrow scale.
- legend_width_fraction=0.2float
Fraction of the width of the axes (as specified by axis_position) dedicated to the legend; if it is shown.
- show_axes=Truebool
If True, shows axes with the coordinates of the circuit.
- axis_position=(0.1, 0.1, 0.85, 0.85)array_like
Position of axis in figure (x0, y0, dx, dy, between 0 and 1)
- arrow_width=0.005float
Width of arrows.
- arrow_scale=1float
Scale-factor for arrows. (length of arrow = arrow_scale * arrow_data)
- arrow_headwidth=3float
Width of head of arrows. (see matplotlib.quiver)
- arrow_headlength=3.5float
Length of head of arrows. (see matplotlib.quiver)
- arrow_headaxislength=3float
Arrow property. (see matplotlib.quiver)
- arrow_minshaft=1float
Arrow property. (see matplotlib.quiver)
- arrow_minlength=1float
Arrow property. (see matplotlib.quiver)
- arrow_color=(0.15, 0.3, 0.8)color
Color of arrows.
- arrow_alpha=1float
Transparency of arrows.
- arrow_label=””str
Label given to arrow data in legend.
- show_nodes=Truebool
If True, nodes are displayed as circles.
- node_diameter=0.25float
Diameter of nodes.
- node_face_color=(1,1,1)color
Color of faces of nodes. Only used if there is no node data.
- node_edge_color=(0, 0, 0)color
Color of edge of nodes. Only used if there is no node data.
- nodes_as_voronoi=Falsebool
If True, node data is visualized as colors of faces of a voronoi diagram based on node coordinates rather than color of circles at node coordinates.
- node_alpha=1float
Transparency of nodes.
- node_quantity_cmap=Nonecolormap or None
Colormap for node_data.
- node_quantity_clim=None(float, float) or None
Color limits for node_data.
- node_quantity_alpha=1float
Transparency of colors used to represent node_data.
- node_quantity_logarithmic_colors=Falsebool
If True, node_data color-scale is logarithmic.
- node_label=””str
Label given to the node colormap.
- face_quantity_cmap=Nonecolormap or None
Colormap for face_data.
- face_quantity_clim=None(float, float) or None
Color limits for face_data.
- face_quantity_alpha=1float
Transparency of colors used to represent face_data.
- face_quantity_logarithmic_colors=Falsebool
If True, face_data color-scale is logarithmic.
- face_label=””str
Label given to the face colormap.
- figsize=None(float, float) or None
Size of figure in inches.
- title=””str
Title given to figure.
- fig=Nonematlplotlib figure or None
figure where the axis is embedded. If None, a new figure is created.
- circuit
Methods
Get data visualized with arrows.
Get handle containing visualization of arrow_data.
Returns main axes containing the visualization of the circuit.
Get handle of first (left) colorbar.
Get handle of second (right) colorbar.
Get data visualized at faces with colors.
Get handle containing visualization of face_data.
Returns figure handle.
Get handle containing grid.
Get data visualized with junctions.
Get axis-handle containing the legend (with arrow-scale, vortex symbol legend and colormaps).
Get data visualized at nodes.
Get handle containing visualization of node_data.
Get integer data visualized at faces with symbols.
Get handles containing vortex symbols.
make
()Make circuit plot.
- get_colorbar1_handle()[source]¶
Get handle of first (left) colorbar. Representing node-or face data colors.
- class circuit_visualize.ConfigPlot(config: pyjjasim.static_problem.StaticConfiguration, node_quantity=None, junction_quantity='I', face_quantity=None, vortex_quantity='n', vortex_diameter=0.25, vortex_color=(0, 0, 0), anti_vortex_color=(0.8, 0.1, 0.2), vortex_alpha=1, _vortex_range=None, manual_vortex_label=None, show_grid=True, grid_width=1, grid_color=(0.4, 0.5, 0.6), grid_alpha=0.5, show_colorbar=True, show_legend=True, legend_width_fraction=0.2, show_axes=True, axis_position=(0.1, 0.1, 0.85, 0.85), arrow_width=0.005, arrow_scale=1, arrow_headwidth=3, arrow_headlength=3.5, arrow_headaxislength=3, arrow_minshaft=1, arrow_minlength=1, arrow_color=(0.15, 0.3, 0.8), arrow_alpha=1, manual_arrow_label=None, show_nodes=True, node_diameter=0.25, node_face_color=(1, 1, 1), node_edge_color=(0, 0, 0), nodes_as_voronoi=False, node_alpha=1, node_quantity_cmap=None, manual_node_label=None, node_quantity_clim=None, node_quantity_alpha=1, node_quantity_logarithmic_colors=False, face_quantity_cmap=None, face_quantity_clim=None, face_quantity_alpha=1, face_quantity_logarithmic_colors=False, manual_face_label=None, figsize=None, title='', fig=None)[source]¶
Visualize static configuration on a circuit.
- Allows one to show node quantities, junction quantities, face quantities and vortices.
Node quantities are shown as colors on the nodes.
Junction quantities are displayed at the junctions as arrows, where the length of the arrows is proportional to the quantity value.
Face quantities are shown as colors on the faces.
Vortices are displayed by symbols (concentric rings, vorticity equals nr of rings, color shows sign).
- Parameters
- config
static_problem.StaticConfiguration
Static configuration to plot.
- node_quantity=Nonestr or None
- What physical quantity of config to visualize at nodes. Options:
“” or None : no quantity displayed
“phi” : gauge dependent phases
“Is_node” : current sourced at nodes
- junction_quantity=”I”str or None
- What physical quantity of config to visualize on junctions. Options:
“” or None : no quantity displayed
“theta” : gauge invariant phase difference
“I” : current
“Is” : junction current sources
“EJ” : josephson energy
“EM” : magnetic energy
“Etot” : total energy
- face_quantity=Nonestr or None
- What physical quantity of config to visualize at faces. Options:
“” or None : no quantity displayed
“flux” : magnetic flux through face
“J” : cycle-current
“n” : vorticity
- vortex_quantity=”n”str or None
- What face-integer physical quantity of config to visualize with vortex symbols. Options:
“” or None : no quantity displayed
“n” : vortices
- vortex_diameter=0.25float
Diameter of vortex symbols.
- vortex_color=(0, 0, 0)color
Color of vortex symbols.
- anti_vortex_color=(0.8, 0.1, 0.2)color
Color of anti-vortex symbols, whose data is negative.
- vortex_alpha=1float
Transparency of vortex symbols.
- manual_vortex_label=Nonestr or None
Label given to vortices in the legend.
- show_grid=Truebool
Display a grid at the edges of the graph.
- grid_width=1float
Width of lines of grid.
- grid_color=(0.4, 0.5, 0.6)color
Color of grid.
- grid_alpha=0.5float
Transparency of grid.
- show_colorbar=Truebool
Show colorbar mapping face and/or node data to colors.
- show_legend=Truebool
Show legend which includes colormaps, explanation of vortex sybols and an arrow scale.
- legend_width_fraction=0.2float
Fraction of the width of the axes (as specified by axis_position) dedicated to the legend; if it is shown.
- show_axes=Truebool
If True, shows axes with the coordinates of the circuit.
- axis_position=(0.1, 0.1, 0.85, 0.85)array_like
Position of axis in figure (x0, y0, dx, dy, between 0 and 1)
- arrow_width=0.005float
Width of arrows.
- arrow_scale=1float
Scale-factor for arrows. (length of arrow = arrow_scale * arrow_data)
- arrow_headwidth=3float
Width of head of arrows. (see matplotlib.quiver)
- arrow_headlength=3.5float
Length of head of arrows. (see matplotlib.quiver)
- arrow_headaxislength=3float
Arrow property. (see matplotlib.quiver)
- arrow_minshaft=1float
Arrow property. (see matplotlib.quiver)
- arrow_minlength=1float
Arrow property. (see matplotlib.quiver)
- arrow_color=(0.15, 0.3, 0.8)color
Color of arrows.
- arrow_alpha=1float
Transparency of arrows.
- manual_arrow_label=Nonestr or None
Label given to arrows in the legend.
- show_nodes=Truebool
If True, nodes are displayed as circles.
- node_diameter=0.25float
Diameter of nodes.
- node_face_color=(1,1,1)color
Color of faces of nodes. Only used if there is no node data.
- node_edge_color=(0, 0, 0)color
Color of edge of nodes. Only used if there is no node data.
- nodes_as_voronoi=Falsebool
If True, node data is visualized as colors of faces of a voronoi diagram based on node coordinates rather than color of circles at node coordinates.
- node_alpha=1float
Transparency of nodes.
- node_quantity_cmap=Nonecolormap or None
Colormap for node_data
- node_quantity_clim=None(float, float) or None
Color limits for node_data.
- node_quantity_alpha=1float
Transparency of colors used to represent node_data.
- node_quantity_logarithmic_colors=Falsebool
If True, node_data color-scale is logarithmic.
- manual_node_label=Nonestr or None
Label given to node data in the legend.
- face_quantity_cmap=Nonecolormap or None
Colormap for face_data.
- face_quantity_clim=None(float, float) or None
Color limits for face_data.
- face_quantity_alpha=1float
Transparency of colors used to represent face_data.
- face_quantity_logarithmic_colors=Falsebool
If True, face_data color-scale is logarithmic.
- manual_face_label=Nonestr or None
Label given to face data in the legend.
- figsize=None(float, float) or None
Size of figure in inches.
- title=””str
Title given to figure.
- config
Methods
get_arrow_data
()Get data visualized with arrows.
get_arrow_data_handles
()Get handle containing visualization of arrow_data.
get_axes_handle
()Returns main axes containing the visualization of the circuit.
get_colorbar1_handle
()Get handle of first (left) colorbar.
get_colorbar2_handle
()Get handle of second (right) colorbar.
get_face
()Get physical quantity displayed at faces with colors.
get_face_data
()Get data visualized at faces with colors.
get_face_data_handle
()Get handle containing visualization of face_data.
get_figure_handle
()Returns figure handle.
get_grid_handle
()Get handle containing grid.
get_junction_data
()Get data visualized with junctions.
Get physical quantity displayed at junctions.
get_legend_axis_handle
()Get axis-handle containing the legend (with arrow-scale, vortex symbol legend and colormaps).
get_node_data
()Get data visualized at nodes.
get_node_data_handle
()Get handle containing visualization of node_data.
Get physical quantity displayed at nodes.
get_vortex_data
()Get integer data visualized at faces with symbols.
get_vortex_data_handles
()Get handles containing vortex symbols.
Get integer physical quantity displayed at faces with symbols.
make
()Make circuit plot.
- get_face()[source]¶
Get physical quantity displayed at faces with colors. (None, “flux”, ” n” or “J”)
- class circuit_visualize.TimeEvolutionMovie(config: pyjjasim.time_evolution.TimeEvolutionResult, problem_nr=0, time_points=None, node_quantity=None, junction_quantity='I', face_quantity=None, vortex_quantity='n', vortex_diameter=0.25, vortex_color=(0, 0, 0), anti_vortex_color=(0.8, 0.1, 0.2), vortex_alpha=1, _vortex_range=None, manual_vortex_label=None, show_grid=True, grid_width=1, grid_color=(0.4, 0.5, 0.6), grid_alpha=0.5, show_colorbar=True, show_legend=True, legend_width_fraction=0.2, show_axes=True, axis_position=(0.1, 0.1, 0.85, 0.85), arrow_width=0.005, arrow_scale=1, arrow_headwidth=3, arrow_headlength=3.5, arrow_headaxislength=3, arrow_minshaft=1, arrow_minlength=1, arrow_color=(0.15, 0.3, 0.8), arrow_alpha=1, manual_arrow_label=None, show_nodes=True, node_diameter=0.25, node_face_color=(1, 1, 1), node_edge_color=(0, 0, 0), nodes_as_voronoi=False, node_alpha=1, node_quantity_cmap=None, node_quantity_clim=None, node_quantity_alpha=1, node_quantity_logarithmic_colors=False, manual_node_label=None, face_quantity_cmap=None, face_quantity_clim=None, face_quantity_alpha=1, face_quantity_logarithmic_colors=False, manual_face_label=None, figsize=None, title='', animate_interval=10, fig=None)[source]¶
Visualize time evolution on a circuit as a movie.
- Allows one to show node quantities, junction quantities, face quantities and vortices.
Node quantities are shown as colors on the nodes.
Junction quantities are displayed at the junctions as arrows, where the length of the arrows is proportional to the quantity value.
Face quantities are shown as colors on the faces.
Vortices are displayed by symbols (concentric rings, vorticity equals nr of rings, color shows sign).
- Parameters
- config
time_evolution.TimeEvolutionResult
Time evolution to visualize.
- node_quantity=Nonestr or None
- What physical quantity of config to visualize at nodes. Options:
“” or None : no quantity displayed
“phi” : gauge dependent phases
“Is_node” : current sourced at nodes
“U” : Voltage potential
- junction_quantity=”I”str or None
- What physical quantity of config to visualize on junctions. Options:
“” or None : no quantity displayed
“theta” : gauge invariant phase difference
“I” : current
“V” : Voltage
“Isuper” : supercurrent
“Is” : junction current sources
“EJ” : josephson energy
“EM” : magnetic energy
“EC” : capacative energy
“Etot” : total energy
- face_quantity=Nonestr or None
- What physical quantity of config to visualize at faces. Options:
“” or None : no quantity displayed
“flux” : magnetic flux through face
“J” : cycle-current
“n” : vorticity
- vortex_quantity=”n”str or None
- What face-integer physical quantity of config to visualize with vortex symbols. Options:
“” or None : no quantity displayed
“n” : vortices
- vortex_diameter=0.25float
Diameter of vortex symbols.
- vortex_color=(0, 0, 0)color
Color of vortex symbols.
- anti_vortex_color=(0.8, 0.1, 0.2)color
Color of anti-vortex symbols, whose data is negative.
- vortex_alpha=1float
Transparancy of vortex symbols.
- manual_vortex_label=Nonestr or None
Label given to vortices in the legend.
- show_grid=Truebool
Display a grid at the edges of the graph.
- grid_width=1float
Width of lines of grid.
- grid_color=(0.4, 0.5, 0.6)color
Color of grid.
- grid_alpha=0.5float
Transparency of grid.
- show_colorbar=Truebool
Show colorbar mapping face and/or node data to colors.
- show_legend=Truebool
Show legend which includes colormaps, explanation of vortex sybols and an arrow scale.
- legend_width_fraction=0.2float
Fraction of the width of the axes (as specified by axis_position) dedicated to the legend; if it is shown.
- show_axes=Truebool
If True, shows axes with the coordinates of the circuit.
- axis_position=(0.1, 0.1, 0.85, 0.85)array_like
Position of axis in figure (x0, y0, dx, dy, between 0 and 1)
- arrow_width=0.005float
Width of arrows.
- arrow_scale=1float
Scale-factor for arrows. (length of arrow = arrow_scale * arrow_data)
- arrow_headwidth=3float
Width of head of arrows. (see matplotlib.quiver)
- arrow_headlength=3.5float
Length of head of arrows. (see matplotlib.quiver)
- arrow_headaxislength=3float
Arrow property. (see matplotlib.quiver)
- arrow_minshaft=1float
Arrow property. (see matplotlib.quiver)
- arrow_minlength=1float
Arrow property. (see matplotlib.quiver)
- arrow_color=(0.15, 0.3, 0.8)color
Color of arrows.
- arrow_alpha=1float
Transparency of arrows.
- manual_arrow_label=Nonestr or None
Label given to arrows in the legend.
- show_nodes=Truebool
If True, nodes are displayed as circles
- node_diameter=0.25float
Diameter of nodes.
- node_face_color=(1,1,1)color
Color of faces of nodes. Only used if there is no node data.
- node_edge_color=(0, 0, 0)color
Color of edge of nodes. Only used if there is no node data.
- nodes_as_voronoi=Falsebool
If True, node data is visualized as colors of faces of a voronoi diagram based on node coordinates rather than color of circles at node coordinates.
- node_alpha=1float
Transparency of nodes.
- manual_node_label=Nonestr or None
Label given to node data in the legend.
- node_quantity_cmap=Nonecolormap or None
Colormap for node_data.
- node_quantity_clim=None(float, float) or None
Color limits for node_data.
- node_quantity_alpha=1float
Transparency of colors used to represent node_data.
- node_quantity_logarithmic_colors=Falsebool
If True, node_data color-scale is logarithmic.
- face_quantity_cmap=Nonecolormap or None
Colormap for face_data.
- face_quantity_clim=None(float, float) or None
Color limits for face_data.
- face_quantity_alpha=1float
Transparency of colors used to represent face_data.
- face_quantity_logarithmic_colors=Falsebool
If True, face_data color-scale is logarithmic.
- manual_face_label=Nonestr or None
Label given to face data in the legend.
- figsize=None(float, float) or None
Size of figure in inches.
- title=””str
Title given to figure.
- config
Methods
get_animation_handle
()Return FuncAnimation handle.
get_arrow_data
()Get data visualized with arrows.
get_arrow_data_handles
()Get handle containing visualization of arrow_data.
get_axes_handle
()Returns main axes containing the visualization of the circuit.
get_colorbar1_handle
()Get handle of first (left) colorbar.
get_colorbar2_handle
()Get handle of second (right) colorbar.
get_face
()Get physical quantity displayed at faces with colors.
get_face_data
()Get data visualized at faces with colors.
get_face_data_handle
()Get handle containing visualization of face_data.
get_figure_handle
()Returns figure handle.
get_grid_handle
()Get handle containing grid.
get_junction_data
()Get data visualized with junctions.
Get physical quantity displayed at junctions.
get_legend_axis_handle
()Get axis-handle containing the legend (with arrow-scale, vortex symbol legend and colormaps).
get_node_data
()Get data visualized at nodes.
get_node_data_handle
()Get handle containing visualization of node_data.
Get physical quantity displayed at nodes.
get_vortex_data
()Get integer data visualized at faces with symbols.
get_vortex_data_handles
()Get handles containing vortex symbols.
Get physical quantity displayed at faces with symbols.
make
()Make circuit plot.
- get_face()[source]¶
Get physical quantity displayed at faces with colors. (None, “flux”, ” n” or “J”)
- get_junction_quantity()[source]¶
Get physical quantity displayed at junctions. (None, “th”, “I”, “V”, “Isup”, “Is”, “EJ”, “EM”, “EC” or “Etot”)