From 4a48b23dec06df59a4f67e15e7d517a4816ce2c9 Mon Sep 17 00:00:00 2001 From: Anton Akhmerov <anton.akhmerov@gmail.com> Date: Mon, 18 Mar 2013 11:50:35 +0100 Subject: [PATCH] mention HoppingKind in whatsnew --- doc/source/whatsnew/0.3.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/source/whatsnew/0.3.rst b/doc/source/whatsnew/0.3.rst index 94e31342..135ed994 100644 --- a/doc/source/whatsnew/0.3.rst +++ b/doc/source/whatsnew/0.3.rst @@ -3,6 +3,26 @@ What's New in kwant 0.3 This article explains the user-visible changes in kwant 0.3. +``possible_hoppings`` replaced by `~kwant.builder.HoppingKind` +-------------------------------------------------------------- +The `~kwant.builder.Builder` method ``possible_hoppings`` has been rendered +obsolete. Where previously one would have had :: + + for kind in lat.nearest: + sys[sys.possible_hoppings(*kind)] = t + +now it suffices to write :: + + sys[lat.nearest] = t + +This is possible because `~kwant.builder.Builder` now accepts *functions* as +keys in addition to `~kwant.builder.Site` objects and tuples of them +(hoppings). These functions are expected to yield either sites or hoppings, +when given a builder instance as the sole argument. The use of such keys is to +implement sets of sites or hoppings that depend on what is already present in +the builder, such as `~kwant.builder.HoppingKind`. In the above example, +``lat.nearest`` is a list of ``HoppingKind`` objects. + Immutable site groups --------------------- In order to make naming more consistent, `kwant.make_lattice` was renamed and -- GitLab