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

doc: add wraparound module to documentation

Closes #113.
parent c2beb80a
No related branches found
No related tags found
No related merge requests found
...@@ -38,3 +38,4 @@ The following modules provide functionality for special applications. ...@@ -38,3 +38,4 @@ The following modules provide functionality for special applications.
kwant.digest kwant.digest
kwant.rmt kwant.rmt
kwant.kpm kwant.kpm
kwant.wraparound
...@@ -12,6 +12,7 @@ Plotting routine ...@@ -12,6 +12,7 @@ Plotting routine
plot plot
map map
bands bands
spectrum
Data-generating functions Data-generating functions
------------------------- -------------------------
......
:mod:`kwant.wraparound` -- Wrapping around translational symmetries
===================================================================
.. module:: kwant.wraparound
.. autosummary::
:toctree: generated/
wraparound
plot_2d_bands
...@@ -384,7 +384,7 @@ def plot_2d_bands(syst, k_x=31, k_y=31, params=None, ...@@ -384,7 +384,7 @@ def plot_2d_bands(syst, k_x=31, k_y=31, params=None,
See Also See Also
-------- --------
`kwant.plotter.spectrum` kwant.plotter.spectrum
""" """
if not hasattr(syst, '_wrapped_symmetry'): if not hasattr(syst, '_wrapped_symmetry'):
raise TypeError("Expecting a system that was produced by " raise TypeError("Expecting a system that was produced by "
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment