From a4897538511fe29fba230307612425d484dd58ee Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph@weston.cloud>
Date: Mon, 22 Jul 2019 15:16:53 +0200
Subject: [PATCH] add note about magnetic field units to "discretize_landau"

Closes #305.
---
 kwant/continuum/landau_levels.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/kwant/continuum/landau_levels.py b/kwant/continuum/landau_levels.py
index 90544579..13e70c4e 100644
--- a/kwant/continuum/landau_levels.py
+++ b/kwant/continuum/landau_levels.py
@@ -95,6 +95,13 @@ def discretize_landau(hamiltonian, N, momenta=None, grid_spacing=1):
         'hamiltonian' discretized in a basis of Landau levels in the plane
         defined by 'momenta'. If a third coordinate is present in 'hamiltonian',
         then this also has a translational symmetry in that coordinate direction.
+        The builder has a parameter 'B' in addition to any other parameters
+        present in the provided 'hamiltonian'.
+
+    Notes
+    -----
+    The units of magnetic field are :math:`ϕ₀ / 2 π a²` with :math:`ϕ₀ = h/e`
+    the magnetic flux quantum and :math:`a` the unit length.
     """
 
     if N <= 0:
-- 
GitLab