diff --git a/doc/source/code/figure/discretize.py.diff b/doc/source/code/figure/discretize.py.diff index 9ca0df555e3b8553f7772d6f2253e485e6d4df73..aebaf3e03c10d291d2b25789c1145b90d6210a15 100644 --- a/doc/source/code/figure/discretize.py.diff +++ b/doc/source/code/figure/discretize.py.diff @@ -1,4 +1,4 @@ -@@ -1,222 +1,236 @@ +@@ -1,225 +1,239 @@ # Tutorial 2.9. Processing continuum Hamiltonians with discretize # =============================================================== # @@ -13,6 +13,9 @@ +import _defs import kwant + #HIDDEN_BEGIN_import + import kwant.continuum + #HIDDEN_END_import import scipy.sparse.linalg import scipy.linalg import numpy as np diff --git a/doc/source/code/figure/plot_qahe.py.diff b/doc/source/code/figure/plot_qahe.py.diff index d726f98e908feac22a767b4387c8e6b561523bb4..1788f677df857d1b75b8706aa0907fad4b9a467d 100644 --- a/doc/source/code/figure/plot_qahe.py.diff +++ b/doc/source/code/figure/plot_qahe.py.diff @@ -1,4 +1,4 @@ -@@ -1,71 +1,75 @@ +@@ -1,72 +1,76 @@ # Comprehensive example: quantum anomalous Hall effect # ==================================================== # @@ -16,6 +16,7 @@ import math import matplotlib.pyplot import kwant + import kwant.continuum # 2 band model exhibiting quantum anomalous Hall effect diff --git a/doc/source/conf.py b/doc/source/conf.py index f0272556a1cee688b73c60fdea6574d8792ba5ee..9790aaa58434a0eb868d66bf2b2243677611ee4c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,7 +16,9 @@ import sys, os from distutils.util import get_platform sys.path.insert(0, "../../build/lib.{0}-{1}.{2}".format( get_platform(), *sys.version_info[:2])) + import kwant +import kwant.continuum # sphinx gets confused with lazy loading # -- General configuration ----------------------------------------------------- diff --git a/doc/source/tutorial/discretize.rst b/doc/source/tutorial/discretize.rst index d3c58219ea2baf593bc96fc6e9ded1073aabc634..1ed5015cd2203e100d1d4e4cf9f21ae283716f04 100644 --- a/doc/source/tutorial/discretize.rst +++ b/doc/source/tutorial/discretize.rst @@ -53,6 +53,11 @@ with :math:`A(x) = \frac{\hbar^2}{2 m(x)}`. Using `~kwant.continuum.discretize` to obtain a template ........................................................ +First we must explicitly import the `kwant.continuum` package: + +.. literalinclude:: /code/include/discretize.py + :start-after: #HIDDEN_BEGIN_import + :end-before: #HIDDEN_END_import The function `kwant.continuum.discretize` takes a symbolic Hamiltonian and turns it into a `~kwant.builder.Builder` instance with appropriate spatial