Skip to content
Snippets Groups Projects
Forked from kwant / kwant
713 commits behind the upstream repository.
Christoph Groth's avatar
Christoph Groth authored
The basic idea remains the same, but should work much better now.  The
difference is that images/example.py.diff is now a patch with complete
context and becomes the authoritative source for both the visible flavor
of an example as well as for its figure-generating variant.  Both
tutorial/example.py and images/example.py are extracted from this file
by 'make html'.  Thanks to the complete context the diffs are quite
readable and may be modified directly.

Alternatively, one may also modify the generated scripts.  When
tutorial/example.py has been modified, it will be patched and saved as
images/example.py.  The patching is done using the tool 'wiggle' that
works much better than 'patch'.  If a conflict occurs, conflict markers
are added to the output file and its dated back to the dawn of time
(i.e. 1970) in order to mark the conflicts as not yet resolved.  After
resolving, 'make html' is simply run again.

Upon a successful execution of the figure-generating script the diff
gets recreated automatically, 'generate-diffs' no longer exists.
001dafbb
History

Kwant is a free (open source) Python package for numerical calculations on tight-binding models with a strong focus on quantum transport. It is designed to be flexible and easy to use. Thanks to the use of innovative algorithms, Kwant is often faster than other available codes, even those entirely written in the low level FORTRAN and C/C++ languages.

Tight-binding models can describe a vast variety of systems and phenomena in quantum physics. Therefore, Kwant can be used to simulate

  • metals,
  • graphene,
  • topological insulators,
  • quantum Hall effect,
  • superconductivity,
  • spintronics,
  • molecular electronics,
  • any combination of the above, and many other things.

Kwant can calculate

  • transport properties (conductance, noise, scattering matrix),
  • dispersion relations,
  • modes,
  • wave functions,
  • various Green’s functions,
  • out-of-equilibrium local quantities.

Other computations involving tight-binding Hamiltonians can be implemented easily.

See the Kwant web site for the latest stable version. The current development version is available via the Kwant gitlab instance. Contributions are welcome.

A mailing list exists for general discussions related to Kwant. Please report bugs and other issues using the issue tracker.

See also in this directory: INSTALL.rst, LICENSE.rst, AUTHORS.rst, CITING.rst, CONTRIBUTE.rst.