.gitignore

 *~
 *.pyc
-/catalog.yaml
+.doit.db
+cache/
+output/

.gitlab-ci.yml

+image: kwant/website-deploy
+
+before_script:
+  - nikola build
+  - mkdir -p ~/.ssh
+  - chmod 700 ~/.ssh
+  - eval $(ssh-agent -s)
+
+test_deploy:
+  script:
+    - echo "$TEST_WEBSITE_KEY" | tr -d '\r' | ssh-add -
+    - nikola deploy
+  except:
+    - master
+
+master_deploy:
+  script:
+    - echo "$MASTER_WEBSITE_KEY" | tr -d '\r' | ssh-add -
+    - nikola deploy master
+  only:
+    - master

content/2015-survey.rst

+Kwant user survey
+=================
+
+The kwant user survey is finished, please use the `mailing list
+</community.html>`_ if you would like to leave feedback.

content/about.rst

+Quantum transport simulations made easy
+=======================================
+
+Kwant is a `free (open source) <https://gitlab.kwant-project.org/kwant/kwant>`_ 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 does not use the traditional input files often found in scientific
+software packages. Instead, one writes short programs in the powerful yet
+easy-to-learn Python language.  These programs define a system and calculate its
+quantum properties (conductance, density of states, etc).  This workflow can be
+summarized as follows:
+
+.. raw:: html
+
+    <object type="image/svg+xml" data="kwant-workflow.svgz" class="img-responsive">kwant-workflow.svgz</object>
+
+Kwant was designed to be easy to use: Section 2 of the `Kwant paper
+<http://downloads.kwant-project.org/doc/kwant-paper.pdf>`_ contains a
+line-by-line walkthrough of a program very similar to the one used to generate
+the above image.  That complete Python script is 26 lines long (including
+comments).
+
+
+Examples of Kwant usage
+-----------------------
+
+The following examples are meant to give an overview of what is possible with
+Kwant.  The tutorial section of `Kwant documentation <doc/1/>`_ and the
+`Kwant paper`_ each contain several pedagogical examples with line-by-line
+explanations (`zipfile of all examples
+<http://downloads.kwant-project.org/examples/kwant-examples-1.0.0.zip>`_).
+
+Graphene flake
+..............
+
+.. raw:: html
+
+       <object type="image/svg+xml" class="col-md-4 pull-left img-responsive" data="graphene-edgestate.svgz">graphene-edgestate.svgz</object>
+
+The complete code that constructs the graphene flake shown on the right side is
+
+.. code:: python
+
+          def disk(pos):
+              x, y = pos
+              return x**2 + y**2 < 8**2
+
+          lat = kwant.lattice.honeycomb()
+          syst = kwant.Builder()
+          syst[lat.shape(disk, (0, 0))] = 0
+          syst[lat.neighbors()] = -1
+
+In addition to the flake itself, the image also shows the wave function of a
+low energy eigenstate. The size of each circle is proportional to the wave
+function probability amplitude on that site.  It can be clearly seen that the
+wave function is peaked near the zigzag segments of the boundary, as `expected
+<http://arxiv.org/abs/1003.4602>`_ for graphene quantum dots.
+
+Taken from the Kwant `plotting tutorial <doc/1/tutorial/tutorial6.html>`_.
+
+.. class:: row nomargin
+
+Quantum Hall effect
+...................
+
+.. raw:: html
+
+       <object type="image/svg+xml" class="col-md-4 img-responsive pull-left" data="qhe-edgestate.svgz">qhe-edgestate.svgz</object>
+
+       <object type="image/svg+xml" class="col-md-4 img-responsive pull-right" data="qhe-plateaus.svgz">qhe-plateaus.svgz</object>
+
+
+One of the most common applications of Kwant is to calculate the conductance of
+a nanoelectronic system.  The plot on the left shows the conductance through a
+2-d electron gas as a function of magnetic flux.  The quantization of
+conductance that is visible (plateaus) is the hallmark of the quantum Hall
+effect.  The third plateau does not develop due to a constriction in the system
+that leads to backscattering.  The scattering wave function from the left lead
+at magnetic field strength corresponding to the middle of the third QHE plateau
+is shown on the right.
+
+Taken from example 6 of the `Kwant paper
+<http://downloads.kwant-project.org/doc/kwant-paper.pdf>`_.
+
+.. class:: row
+
+3-d system: Majorana states
+...........................
+
+.. class:: col-md-4 img-responsive pull-left
+
+.. image:: quantum-wire.png
+
+Kwant allows systems of any dimensionality, for example three-dimensional ones.
+This image shows a 3-d model of a semiconducting quantum wire (gray cylinder).
+The red region is a tunnel barrier, used to measure tunneling conductance, the
+blue region is a superconducting electrode.  In this simulated device, a
+Majorana bound state appears close to the superconducting-normal interface.
+
+Taken from an unpublished work by S. Mi, A. R. Akhmerov, and M. Wimmer.
+
+.. class:: row
+
+Numerical experiment: flying qubit
+..................................
+
+.. class:: col-md-4 col-sm-12 img-responsive pull-right
+
+.. image:: flying-qubit.png
+
+Numerical simulations and experimental results for a flying qubit sample made in
+a GaAs/GaAlAs heterostrucutre. The Kwant simulations were performed with
+particular attention to a realistic model of the confining potential seen by the
+electrons.  This allows for rather subtle aspects of the experiment could be
+reproduced.  Such "numerical experiments" can not only be used to interpret the
+experimental data but also can help to design the sample geometry and in to
+choose the right materials.
+
+Taken from an unpublished work by T. Bautze et al.  See Yamamoto et al., `Nature
+Nanotechnology 7, 247 (2012) <http://dx.doi.org/doi:10.1038/nnano.2012.28>`_ for
+details about the experiment.
+
+.. class:: row
+
+Conductance of a Corbino disk in a quantum Hall regime
+......................................................
+
+.. raw:: html
+
+   <object type="image/svg+xml" class="col-md-4 col-sm-6 img-responsive pull-left" data="corbino-layout.svgz">corbino-layout.svgz</object>
+
+.. class:: col-md-4 col-sm-6 img-responsive pull-right
+
+.. image:: corbino-conductance.png
+
+Transport properties of a Corbino disk across a quantum Hall transition. Left:
+geometry of the sample consisting of a ring-shaped two-dimensional electron gas
+(grey) in a perpendicular magnetic field.  Right: conductance across the
+transition, showing quantized conductance peaks.
+
+Taken from I. C. Fulga, F. Hassler, A. R. Akhmerov, C. W. J. Beenakker,
+`Phys. Rev. B 84, 245447 (2011)
+<http://link.aps.org/doi/10.1103/PhysRevB.84.245447>`_; `arXiv:1110.4280
+<http://arxiv.org/abs/1110.4280>`_.

content/authors.rst

+================
+Authors of Kwant
+================
+
+The principal developers of kwant are:
+
+* `Christoph W. Groth <mailto:christoph.groth@cea.fr>`_ (SPSMS-INAC-CEA
+  Grenoble)
+* `Michael Wimmer <http://www.lorentz.leidenuniv.nl/~wimmer/>`_ (TU Delft)
+* `Anton R. Akhmerov <http://antonakhmerov.org>`_ (TU Delft)
+* `Xavier Waintal <http://inac.cea.fr/Pisp/xavier.waintal/>`_ (SPSMS-INAC-CEA
+  Grenoble)
+
+Kwant authors should be reached via email authors@kwant-project.org. Please use
+the `mailing list </community.html>`_ for any Kwant-related question that can
+be discussed publicly.
+
+Other people that have contributed to Kwant include
+
+* Daniel Jaschke (SPSMS-INAC-CEA Grenoble)
+* Joseph Weston (SPSMS-INAC-CEA Grenoble)
+
+We thank Christoph Gohlke for the creation of Windows installers.
+
+`CEA <http://cea.fr>`_ is the French Commissariat à l'énergie atomique et aux
+énergies alternatives.  The CEA is the copyright holder for the contributions of
+C. W. Groth, X. Waintal, and its other employees involved in Kwant.
+
+To find out who wrote a certain part of Kwant, please use the "blame" feature of
+`Git <http://git-scm.com/>`_, the version control system.
+
+
+Funding
+-------
+
+During the development of Kwant 1.0, A. R. Akhmerov and M. Wimmer were supported
+by the Dutch Science Foundation NWO/FOM and by the ERC Advanced Investigator
+Grant of C. W. J. Beenakker who enthousiastically supported this project.
+A. R. Akhmerov was partially supported by a Lawrence Golub fellowship.
+C. W. Groth and X. Waintal were supported by the ERC Consolidator Grant MesoQMC.
+X. Waintal also acknowledges support from the STREP ConceptGraphene.

content/cite.rst

+Citing Kwant
+============
+
+We provide Kwant as free software under a `BSD license </license.html>`_ as a
+service to the physics community.  If you have used Kwant for work that has
+lead to a scientific publication, please mention the fact that you used it
+explicitly in the text body.  For example, you may add
+
+  *the numerical calculations were performed using the Kwant code*
+
+to the description of your numerical calculations.  In addition, we ask you to
+cite the main paper that introduces Kwant:
+
+  C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal,
+  *Kwant: a software package for quantum transport*,
+  `New J. Phys. 16, 063065 (2014)
+  <http://iopscience.iop.org/1367-2630/16/6/063065/article>`_.
+
+
+Other references we ask you to consider
+---------------------------------------
+
+If you have profited from the quantum transport functionality of Kwant, please
+also cite the upcoming paper that describes the relevant algorithms. The
+reference will also be added here once it is available.
+
+Kwant owes much of its current performance to the use of the `MUMPS
+<http://graal.ens-lyon.fr/MUMPS/>`_ library for solving systems of sparse linear
+equations.  If you have done high-performance calculations, we suggest citing
+
+  P. R. Amestoy, I. S. Duff, J. S. Koster, J. Y. L’Excellent, SIAM. J. Matrix
+  Anal. & Appl. 23 (1), 15 (2001).
+
+Finally, if you use the routine for generation of circular ensembles of random
+matrices, please cite
+
+  \F. Mezzadri, Notices Am. Math. Soc. 54, 592 (2007).

content/community.rst

+The Kwant community
+===================
+
+The Kwant project is an international collaboration.
+Everybody is welcome to participate in the community
+by asking and replying to questions, reporting bugs, providing suggestions,
+and `contributing to the code and documentation </contribute.html>`_.
+
+The Kwant community uses three public communication channels:
+the mailing list for generic discussions, questions, and announcements;
+the gitlab instance for development discussions and reporting bugs;
+and the chat for real-time discussions related to development.
+
+A list of `Kwant authors </authors>`_ is included in the documentation.
+Please contact the authors directly only for matters that cannot be discussed on the public channels.
+
+
+Mailing list
+------------
+
+The kwant-discuss mailing list is the main public communication platform for anything related to Kwant:
+questions, discussions, development, and announcements.
+It may be used both as a web forum and as a classical mailing list.
+
+The `kwant-discuss web interface <https://mail.python.org/archives/list/kwant-discuss@python.org/>`_
+allows to follow discussions and search the archives.
+
+To start a new discussion thread, you may either use the web interface
+(sign-in required)
+or write directly to
+kwant-discuss@python.org.
+In order to avoid spam,
+messages of unsubscribed participants are held for moderation.
+
+Similarly, replying is possible either by mail
+(if you received the post to which you want reply by mail),
+or using the web interface:
+the “reply” button under each message allows to compose directly
+(for signed-in users),
+or triggers a reply by mail (otherwise).
+
+You may subscribe to receive posts to the list by mail.
+Subscription is done either through the
+`kwant-discuss info page
+<https://mail.python.org/mailman3/lists/kwant-discuss.python.org/>`_
+or by sending any message to
+kwant-discuss-join@python.org.
+(The subject and content are ignored and may be empty.)
+To unsubscribe, either use the info page,
+or send any message to kwant-discuss-leave@python.org.
+
+List etiquette :
+
+- When asking questions,
+  `help others to help you <https://stackoverflow.com/help/how-to-ask>`_.
+  In particular, use the search function before posting.
+
+- When replying, please avoid quoting the complete original message.
+  Instead, consider
+  `bottom-posting <https://en.wikipedia.org/wiki/Posting_style#Bottom-posting>`_.
+
+
+Announcements mailing list
+--------------------------
+
+This read-only list is used for important announcements like new releases of Kwant.
+Only a few messages are sent per year.
+These announcements are also posted on the main mailing list,
+so there is no need to subscribe to both lists.
+We recommend every user of Kwant to subscribe at least to this list in order to stay informed about new developments.
+
+The `kwant-announce archives <https://mail.python.org/archives/list/kwant-announce@python.org/>`_
+are available on the web.
+
+To subscribe, either use the form on the `kwant-announce info page <https://mail.python.org/mailman3/lists/kwant-announce.python.org/>`_
+or simply send any message to kwant-announce-join@python.org.
+(The subject and content are ignored and may be empty.)
+To unsubscribe, either use the info page, or send any message to kwant-announce-leave@python.org.
+
+
+Development chat
+----------------
+
+The Kwant developer chat is accessible to the community via `Gitter <https://gitter.im/kwant-project/Lobby>`_.
+Come say hi if you would like to get involved with developing Kwant!
+
+
+Gitlab instance
+---------------
+
+The Kwant project runs a `gitlab instance <https://gitlab.kwant-project.org/>`_
+that hosts the `main Kwant code repository <https://gitlab.kwant-project.org/kwant/kwant>`_
+as well as the `repositories of related projects <https://gitlab.kwant-project.org/kwant>`_.
+The gitlab instance is used for reporting bugs (see next section) and `development </contribute.html>`_
+
+
+Reporting bugs
+--------------
+
+If you encounter a problem with Kwant,
+first try to reproduce it with as simple a system as possible.
+Double-check with the documentation that what you observe is actually a bug in Kwant.
+If you think it is, please check `the list of known bugs in Kwant <https://gitlab.kwant-project.org/kwant/kwant/issues?label_name=bug>`_.
+It may be also a good idea to search or ask on the general mailing list.
+(You can use the search box at the top of this page.)
+
+If after checking you still think that you have found a bug, please add it to
+the above-mentioned list of bugs by creating an issue with the “bug” label.  A
+useful bug report should contain:
+
+- The versions of software you are using: Kwant, Python, operating system, etc.
+
+- A description of the problem, i.e. what exactly goes wrong.  This should
+  include any relevant error messages.
+
+- Enough information to reproduce the bug, preferably in the form of a simple
+  script.

content/contribute.rst

+Contributing to Kwant
+=====================
+
+We see Kwant not just as a package with fixed functionality, but rather as a
+framework for implementing different physics-related algorithms using a common
+set of concepts.  Contributions to Kwant are highly welcome.  You can help the
+project not only by writing code, but also by reporting bugs, and
+fixing/improving the website and the documentation.
+
+
+Where help is needed
+--------------------
+
+The `Kwant issue tracker
+<https://gitlab.kwant-project.org/kwant/kwant/issues>`_ serves to track bugs
+in Kwant, but most issues are in fact ideas for enhancements.  The issues are
+categorized with labels, so that it is possible to view `all the “easy” issues
+<https://gitlab.kwant-project.org/kwant/kwant/issues?label_name=difficulty%3A+easy>`_
+for example.
+
+Please do feel free to enter new issues yourself.  If you are unsure about some aspect It may be a good idea to discuss your idea on the mailing list kwant-discuss@kwant-project.org before filing an issue.
+
+If you already have some code that extends Kwant in a useful way, please
+consider sharing it.  If your extension fits well with Kwant and is of wide
+enough interest, we will be happy to include it into Kwant proper.  For more
+specialized cases, we will find a solution as well.  (We could, for example,
+add a list of Kwant-related modules to this website.)  In any case, external
+contributions will be clearly marked as such, and relevant papers will be
+added to the list of `suggested acknowledgements </cite.html>`_.
+
+
+Getting the source code
+-----------------------
+
+The source code of released versions of Kwant is available for `download
+<http://downloads.kwant-project.org/kwant/>`_.  You can follow the development
+through the `Kwant page of our GitLab instance
+<https://gitlab.kwant-project.org/kwant/kwant>`_.  The `Git
+<http://git-scm.com/>`_ repository of Kwant can be cloned directly with the
+command ::
+
+    git clone https://gitlab.kwant-project.org/kwant/kwant.git
+
+The Kwant git repository has two main branches: The branch *master*
+contains the development towards the next release.  The branch *stable* contains
+the most recent release that is considered stable, and only bugfixes are applied
+to it.
+
+
+Setting up for development
+--------------------------
+
+When working with the Kwant source, regular `build instructions
+</doc/1/pre/install.html#building-and-installing-from-source>`_ apply.  It
+would be tiresome, however, to have to reinstall the modified Kwant after each
+modification.
+
+One easy way to avoid this is to build in-place so that there is no need to
+reinstall after each change.  This can be done with the following command ::
+
+    python3 setup.py build_ext -i
+
+No further installation is necessary.  The “inner” ``kwant`` subdirectory has
+been turned into a proper Python package that can be imported from the “outer”
+directory, i.e. the directory where ``setup.py`` is located.  Any script
+inside that directory that imports Kwant will get the modified version.  (To
+be able to import the modified Kwant from another directory one can create a
+symbolic link to the package.)
+
+The above ``build_ext`` command does not have to be rerun when a Python file
+is modified.  Recompilation is only necessary whenever a Cython file
+(``.pyx``) has been changed.
+
+
+Modifying the source code
+-------------------------
+
+We recommend that you keep each of your changes to Kwant on a separate “topic
+branch” that starts at *master*.  Try to not mix up unrelated changes in a
+single branch.  To create a topic branch, use the command::
+
+    git checkout -b my_topic master
+
+Now you can begin to implement your idea.  As you go, register your changes
+with Git as explained, for example, in the `Pro Git book
+<https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository>`_
+that is freely available online.
+
+Once you feel that you would like to show your work to other interested people
+(because you would like to receive feedback, or because you consider it
+ready), it's time to inspect your branch.  Run ``git status`` to make sure
+that you have committed all of your changes, then use a tool like ``gitk`` to
+view your branch.
+
+In the following, two methods to share your commits are described.  The first
+will be familiar if you have experience with the popular GitHub service.  If
+you do not, you might prefer the second method, since it is simpler.
+
+
+Method 1: Using the Kwant GitLab instance
+.........................................
+
+Go the `GitLab page of the official Kwant repository
+<https://gitlab.kwant-project.org/kwant/kwant>`_.  Since you do not have write
+access to this repository, you have to create an own “fork” of it by clicking
+on the button just right of the “star” button.
+
+You created a public copy of the Kwant repository that is controlled by you.
+Add it as a remote repository to the clone of Kwant on your computer::
+
+    git remote add own https://gitlab.kwant-project.org/<USERNAME>/kwant.git
+
+You can copy-and-paste your own version of the above URL from the main page of
+your repository.  (If you know about SSH, you may also prefer to upload your
+public ssh key to GitLab and to use SSH as transport.)  The string ``own`` is
+the local name you give to the remote, it can be anything.
+
+Now you can push your topic branch to your repository::
+
+    git push own my_branch
+
+This will make your branch appear in GitLab.  Now you can let us know about
+your branch by `creating a merge request in GitLab
+<https://gitlab.kwant-project.org/help/workflow/forking_workflow.md>`_ or by
+sending a message to kwant-discuss@kwant-project.org.
+
+
+Method 2: Sending patches to the mailing list
+.............................................
+
+Run the command ::
+
+    git format-patch origin/master
+
+This will create a “patch” file for each commit on your branch.  Now simply
+send these patches as email attachments to kwant-discuss@kwant-project.org,
+together with an explanation of your idea.  You do not have to be subscribed
+to the mailing list.
+
+(Or, even better, use ``git send-email`` as shown in this `example of usage
+<https://kernel.org/pub/software/scm/git/docs/git-send-email.html#_example>`_
+and this `git send-email howto
+<http://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/>`_.)
+
+
+Coding style
+------------
+
+* Please keep the code consistent by adhering to the prevailing naming and
+  formatting conventions.  We generally respect the `"Style Guide for Python
+  Code" <http://www.python.org/dev/peps/pep-0008/>`_.  For docstrings, we
+  follow `NumPy's "Docstring Standard"
+  <http://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ and
+  `Python's "Docstring Conventions"
+  <http://www.python.org/dev/peps/pep-0257/>`_.
+
+* Write tests for all the important functionality you add.  Be sure not to
+  break existing tests.
+
+* Create a logical sequence of commits with clear commit messages.  Each
+  commit message consists of a summary line, and, whenever necessary, a
+  more detailed explanation.  Both parts are separated by a blank line
+  and wrapped to 72 characters (unless quoting error messages and such).
+  The summary line should be as clear as possible.  The detailed
+  explanation should be included whenever it helps to motivate or
+  understand the commit.  Bear in mind that the merge request text and
+  discussions are not part of a commit.

content/doc/index.rst

+Documentation
+=============
+
+Tutorial and reference manual
+-----------------------------
+
+.. class:: docs-list, button-links
+
+* **Online**:
+
+  + `stable version </doc/1/>`_
+  + `development version </doc/dev/>`_
+
+* **Downloads**:
+
+  + `PDF <http://downloads.kwant-project.org/doc/latest.pdf>`_
+  + `zipped HTML <http://downloads.kwant-project.org/doc/latest.zip>`_
+
+Interactive online course
+-------------------------
+The APS March meeting 2016 tutorial “Introduction to Computational Quantum Nanoelectronics” focuses on the physics, but also serves as a crash course on Kwant.  `All the materials are available online </mm16.html>`_ and can be run directly in a web browser, without installing Kwant locally.
+
+Screencast
+----------
+
+.. raw:: html
+
+   A brief video introduction of Kwant:
+
+   <ul class="button-links inline-list">
+       <li> <a href="kwant-screencast-2014.html">watch</a> </li>
+       <li> <a href="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4" download>download</a> </li>
+   </ul>
+
+Article
+-------
+
+This paper (`download PDF <http://downloads.kwant-project.org/doc/kwant-paper.pdf>`__) introduces Kwant in a systematic way and discusses its design and performance (`New J. Phys. 16, 063065 (2014) <http://iopscience.iop.org/1367-2630/16/6/063065/article>`_).

content/extensions/index.rst

+================
+Kwant extensions
+================
+
+Going beyond the core package, there are several tools that extend Kwant in useful ways.
+You can check these out below.
+
+If you have some re-usable code that you think would be useful to the wider Kwant community,
+post to the `Kwant development mailing list <mailto:kwant-discuss@kwant-project.org>`_ with a
+link to the code and a couple of sentences describing it, and we'll add it to this page.
+
+
+Semicon: k·p simulations made easy
+----------------------------------
+**Get the code**: https://gitlab.kwant-project.org/semicon/semicon
+
+A package of tools for doing k·p simulations. Contains: model definitions, material parameters,
+and helper functions for generating template Kwant systems.
+
+Generating quasicrystals
+------------------------
+**Get the code**: https://arxiv.org/src/1510.06035v2/anc/quasicrystal.py
+
+Code for reproducing numerics from the paper "`Aperiodic Weak Topological Superconductors <https://arxiv.org/abs/1510.06035>`_"
+by Fulga et al.
+Contains functionality for building 2D Ammann-Beenker tilings, an example of a quasicrystal, and
+Kwant systems constructed from such tilings.
+
+Time-dependent transport
+------------------------
+**Get the code**: https://gitlab.kwant-project.org/kwant/tkwant
+
+A package for defining time-dependent systems with Kwant, and calculating
+time-dependent quantities. Details of the algorithm can be found in the
+following two papers:
+
++ `Towards realistic time-resolved simulations of quantum devices <https://dx.doi.org/10.1007/s10825-016-0855-9>`_
++ `Numerical simulations of time resolved quantum electronics <https://dx.doi.org/10.1016/j.physrep.2013.09.001>`_
+
+Qsymm: Symmetry finder and symmetric Hamiltonian generator
+----------------------------------------------------------
+**Get the code**: https://gitlab.kwant-project.org/qt/qsymm
+
+A package that makes symmetry analysis simple. It automatically generates model Hamiltonians from symmetry constraints and finds the full symmetry group of your Hamiltonian. Works with tight-binging and k dot p Hamiltonians and supports all kinds of symmetries, including conserved quantities, space group symmetries, time reversal, particle-hole and all combinations of these.
+
++ `Qsymm: algorithmic symmetry finding and symmetric Hamiltonian generation <http://dx.doi.org/10.1088/1367-2630/aadf67>`_

content/harvard-only_trial.rst

+Trial pre-release of Kwant
+==========================
+
+With the release of Kwant the instructions that were here were rendered
+obsolete. Please go to the `installation instructions </install.html>`_ for the
+latest Kwant release.

content/index.rst

+Quantum transport simulations made easy
+=======================================
+
+.. raw:: html
+
+    <div class="workflow-image">
+    <object type="image/svg+xml" data="kwant-workflow.svgz" class="img-responsive">kwant-workflow.svgz</object>
+    </div>
+
+Kwant is a `free (open source) <https://gitlab.kwant-project.org/kwant/kwant>`_,
+powerful, and easy to use Python package for numerical calculations on tight-binding
+models with a strong focus on quantum transport.
+
+.. raw:: html
+
+    <div id="recent-posts" class="section col-sm-6">
+    <h2> Recent blog posts </h2>
+
+.. post-list::
+    :stop: 4
+
+.. raw:: html
+
+    </div>
+
+.. raw:: html
+
+    <div id="kwant-uses" class="section col-sm-5">
+    <h2> Use Kwant to... </h2>
+    <ul id="kwant-uses-list">
+        <li>
+        <a href="/about#quantum-hall-effect"> Compute differential conductance </a>
+        </li>
+        <li>
+        <a href="/about#graphene-flake"> Visualize edge states </a>
+        </li>
+        <li>
+        <a href="/about#numerical-experiment-flying-qubit"> Conduct numerical experiments </a>
+        </li>
+        <li>
+        <a href="/doc/1/tutorial/spectrum#band-structure-calculations"> Explore band structure </a>
+        </li>
+        <li>
+        <a href="https://tkwant.kwant-project.org/"> Simulate time-dependent problems </a>
+        </li>
+    </div>

content/install.rst

+================================
+Installing Kwant
+================================
+
+License and citation request
+============================
+Kwant is free software covered by the `2-clause BSD license </license>`_.
+
+If you have used Kwant for work that has lead to a scientific publication,
+please `cite the Kwant paper and possibly other relevant publications
+</cite>`_.
+
+Prerequisites
+=============
+In order to use Kwant you will need to install a distribution of the Python
+language. If you are using a GNU/Linux operating system this should already be
+installed on your computer.
+
+If you are using Mac OS X or Microsoft Windows you will need to install a
+Python distribution yourself. Details of how to do this are in the
+installation instructions of the corresponding platform.
+
+**Kwant version 1.2 and newer requires at least Python 3.4**.
+
+Those who must use Python 2 can still use Kwant up to version 1.1,
+which will receive bug fixes for several years
+after 2015 (but no new features).
+
+The instructions below assume Python 3.  They should be also valid for Python
+2 if all occurrences of ``python3``, ``pip3``, etc. are replaced by
+``python``, ``pip``.
+
+
+Platforms
+=========
+Installation instructions are available for the major operating systems:
+
++ `GNU/Linux`_
++ `Mac OS X`_
++ `Microsoft Windows`_
++ `Building from source`_
+
+GNU/Linux
+=========
+Pre-built packages exist for the following distributions:
+
++ `Debian <#debian-and-derivatives>`_
++ `Ubuntu <#ubuntu-and-derivatives>`_
++ `Arch Linux`_
+
+We also provide `Conda packages <#conda>`_ for users of the `Anaconda
+<https://www.continuum.io/downloads>`_ Python distribution. This is a useful
+option if you do not have root privileges on the machine where you would like
+to install Kwant (e.g. on a computing cluster).
+
+If your distribution is not listed above, and you do not want to use the
+Conda packages, you can always install Kwant using `pip`_. Or by directly
+building `from source <#building-from-source>`_.
+
+
+Debian and derivatives
+----------------------
+The easiest way to install Kwant on a Debian system is using the pre-built
+packages we provide.  We target Debian "stable", but our packages may also work
+on many other recent Debian-derived distributions as well.
+
+The following instructions will install Kwant on Debian stable "buster".
+They need to be executed as root.
+
+1. Add the following lines to ``/etc/apt/sources.list``::
+
+       deb http://ftp.debian.org/debian buster main
+       deb http://downloads.kwant-project.org/debian/ buster main
+       deb-src http://downloads.kwant-project.org/debian/ buster main
+
+2. (Optional) Add the OpenPGP key used to sign the repositories by executing::
+
+       apt-key adv --keyserver keyserver.ubuntu.com --recv-key C3F147F5980F3535
+
+   The fingerprint of the key is 5229 9057 FAD7 9965 3C4F 088A C3F1 47F5 980F
+   3535.
+
+3. Update the package data, and install Kwant::
+
+       apt-get update
+       apt-get install python3-kwant
+
+
+Ubuntu and derivatives
+----------------------
+The easiest way to install Kwant on an Ubuntu system is using the pre-built
+packages we provide.  Execute the following commands in a terminal::
+
+    sudo apt-add-repository -s ppa:kwant-project/ppa
+    sudo apt-get update
+    sudo apt-get install python3-kwant
+
+This should provide up-to-date Kwant for all recent versions of Ubuntu,
+up to at least the last LTS version.
+
+
+Debian or Ubuntu: building packages from source
+-----------------------------------------------
+It is straightforward to build Debian/Ubuntu packages from source.  This can be
+useful when the installation from pre-built packages has failed for some
+reason (e.g. for non-x86 CPUs).
+
+As a prerequisite, a ``deb-src`` entry for Kwant is needed in
+``/etc/apt/sources.list``.  (It will be present if either of the above
+instructions for Debian or for Ubuntu have been followed.)
+
+FIrst, install the build dependencies (as root)::
+
+    apt-get build-dep tinyarray kwant
+
+Then, compile Tinyarray and Kwant.  This may be done as a normal user. ::
+
+    cd /tmp
+    apt-get source --compile tinyarray
+    apt-get source --compile kwant
+
+Finally, install the built packages (again as root)::
+
+    dpkg --install python3-tinyarray_*.deb
+    dpkg --install python3-kwant_*.deb
+
+
+Arch Linux
+----------
+`Arch install scripts for Kwant
+<https://aur.archlinux.org/packages/python-kwant/>`_ are kindly provided by
+Jörg Behrmann (formerly by Max Schlemmer).  To install, follow the `Arch User
+Repository installation instructions
+<https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages>`_.
+Note that for checking the validity of the package you need to add the key
+used for signing to your user's keyring via::
+
+    gpg --keyserver pool.sks-keyservers.net --recv-key C3F147F5980F3535
+
+The fingerprint of the key is 5229 9057 FAD7 9965 3C4F 088A C3F1 47F5 980F
+3535.
+
+
+Mac OS X
+========
+`Pre-built packages <#conda>`_ for Max OS X exist for the Conda package
+manager, which is a part of the ``Anaconda`` Python distribution.
+Using Conda is the recommended way to install Kwant on Mac OS X.
+
+If you do not want to use the Conda packages, you can always install Kwant
+using `pip`_. Or by directly `building from source`_.
+
+We previously maintained Homebrew and Macports packages for Kwant, but due to
+effort required to keep them up to date we have dropped support for these
+installation methods. We recommend that people use the Conda packages
+whenever possible.
+
+
+Microsoft Windows
+=================
+`Pre-built packages <#conda>`_ for Microsoft Windows exist for the Conda
+package manager, which is a part of the ``Anaconda`` Python distribution.
+Using Conda is the recommended way to install Kwant on Microsoft Windows.
+
+We previously recommended using that Kwant packages built by
+Christoph Gohlke, however due to the complexity of the installation
+instructions the Conda packages are preferred. Installation of the
+package provided by Christoph Gohlke is only needed if the integration
+with MUMPS is required (as this is still not available for the Conda packages).
+
+The instructions for installing the alternative package are included below
+
+Alternative Package
+-------------------
+The following instructions explain how to install the official version
+of Python 3, Kwant, and its dependencies.
+
+1. Determine whether you have a 32-bit or 64-bit Windows installation by
+   following these `instructions <http://support.microsoft.com/kb/827218>`_.
+
+2. Download and install Python 3 for the appropriate architecture (32-bit: “x86” or
+   64-bit: “x86-64”) from the official `Python download site for Windows
+   <http://www.python.org/download/windows>`_. The current stable version
+   at the time of writing is Python 3.6.
+
+3. Open a command prompt, as described in "How do I get a command prompt" at
+   the `Microsoft Windows website <http://windows.microsoft.com/en-us/windows/command-prompt-faq>`_.
+
+4. In the command prompt window, execute::
+
+        C:\Python36\python.exe C:\Python36\Tools\Scripts\win_add2path.py
+
+   (Instead of typing this command, you can also just copy it from here and
+   paste it into the command prompt window). If you did not use the default
+   location to install Python in step 2, then replace ``C:\Python36`` by the
+   actual location where Python is installed.  You may also need to adjust the
+   version (“36” signifies Python 3.6).
+
+5. Reboot your computer.
+
+6. Download the necessary packages (with the ending ``.whl``) for your
+   operating system (32 or 64 bit) and Python version (e.g. ``cp35`` for
+   Python 3.5) from the website of `Christoph Gohlke
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_.  For Kwant, we recommend to
+   download at least `NumPy
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy>`_, `SciPy
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy>`_, `Matplotlib
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#matplotlib>`_, `Sympy
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#sympy>`_, `MPMath
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#mpmath>`_, `Pytest
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#pytest>`_, `Six
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#six>`_, `Tinyarray
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#tinyarray>`_, and `Kwant
+   <http://www.lfd.uci.edu/~gohlke/pythonlibs/#kwant>`_ itself.  Make sure to
+   put the downloaded files into a directory without any other ``.whl`` files.
+
+7. Open a command prompt with administrator rights, as described in “How do I
+   run a command with elevated permissions” at the `Microsoft Windows website
+   <http://windows.microsoft.com/en-us/windows/command-prompt-faq>`_.
+
+   Go to the directory with the ``.whl`` files, e.g.::
+
+       cd c:\Users\YOUR_USERNAME\Downloads
+
+   To install all the ``.whl``-files in the current directory, execute ::
+
+       python -c "import pip, glob; pip.main(['install', '--no-deps'] + glob.glob('*.whl'))"
+
+   The above cryptic command is equivalent to ``pip install --no-deps
+   *.whl``, i.e. it installs all the wheel files in the current directory
+   using pip.  Because the Windows command interpreter does not support globs,
+   we have to rely on the globbing as provided by Python itself.
+
+Now you are done, you can ``import kwant`` from within Python scripts.
+
+(Note that many other useful scientific packages are available in Gohlke’s
+repository.  For example, you might want to install `IPython
+<http://www.lfd.uci.edu/~gohlke/pythonlibs/#ipython>`_ and its various
+dependencies so that you can use the `IPython notebook <http://ipython.org/notebook.html>`_.)
+
+If you do not want to use the Conda packages, you can always install Kwant
+using `pip`_. Or by directly `building from source`_.
+
+
+Conda
+=====
+Conda is the package manager for the Anaconda Python distribution.
+
+Kwant currently has Conda packages for GNU/Linux, Mac OS X, and Microsoft Windows.
+
+1. Download the Python 3.6 version of `Anaconda <https://www.continuum.io/downloads>`_ for
+   your platform and install it.
+
+2. Execute the following command in a terminal::
+
+    conda install -c conda-forge kwant
+
+   The above command installs Kwant and all of its dependencies from the
+   ``conda-forge`` channel.
+
+
+``pip``
+=======
+.. caution::
+
+    Installing Kwant with ``pip`` is not easy because Kwant has several
+    non-Python dependencies and requires a C compiler. These instructions
+    are provided for advanced users only.
+
+``pip`` is the standard Python package manager that downloads and installs
+packages from the `Python package index <https://pypi.python.org/>`_.
+
+1. Install the non-Python dependencies of Kwant: a C compiler, BLAS, Lapack,
+   and (optionally) MUMPS (see `Installing non-Python dependencies`_).
+
+2. Execute the following command in a terminal::
+
+    sudo pip3 install kwant
+
+   The above command installs Kwant and all of its Python dependencies from the
+   Python package index.
+
+The latest development build of Kwant can be installed directly from Kwant's
+Git repository::
+
+    sudo pip3 install git+https://gitlab.kwant-project.org/kwant/kwant.git
+
+Each of the above commands will perform a system-wide install (to
+``/usr/local`` on Unix).  Type ``pip3 help install`` for installation options
+and see `pip documentation <https://pip.readthedocs.org/>`_ for a detailed
+description of ``pip``.
+
+Installing non-Python dependencies
+----------------------------------
+
+As mentioned above, ``pip`` will not install any non-Python dependencies
+required by Kwant. Kwant has several non-Python dependencies:
+
++ a C compiler (e.g. ``gcc``)
++ BLAS
++ Lapack
++ `MUMPS <http://graal.ens-lyon.fr/MUMPS/>`_.
+
+If you using a GNU/Linux system then your distribution probably has packages
+for these libraries; you will need to install the `-dev` or `-devel` versions
+of the packages.
+
+As an example, on a Debian or Ubuntu system, the following
+command will install the non-Python dependencies of Kwant::
+
+    sudo apt-get install build-essential gfortran libopenblas-dev liblapack-dev libmumps-scotch-dev
+
+On Debian or Ubuntu systems the Kwant build scripts should find libraries that
+have been installed in the above way automatically.  This will be signaled at
+the end of the build process as follows::
+
+    ******************************** Build summary ********************************
+    Default LAPACK and BLAS
+    Auto-configured MUMPS
+    *******************************************************************************
+
+On other platforms it is possible that MUMPS is not linked against Kwant during
+installation.  If this is the case the build process must be `configured
+manually <doc/1/pre/install.html#build-configuration>`_ by writing a
+``build.conf`` file.  You can then tell ``pip`` to use this ``build.conf`` when
+installing kwant::
+
+    sudo pip install --global-option="--configfile=/path/to/build.conf" kwant
+
+
+Building from source
+====================
+If no packages are available for the system you use, or if you would like to
+build Kwant from source for another reason (expert users may want to customize
+Kwant to use certain optimized versions of libraries), you can `download
+the source code <https://downloads.kwant-project.org/kwant>`_ and consult the
+documentation on `how to install Kwant from source <doc/1/pre/install.html>`_.

content/license.rst

+Kwant license
+=============
+
+Copyright 2011-2015 C. W. Groth (CEA), M. Wimmer, A. R. Akhmerov,
+X. Waintal (CEA), and others.  All rights reserved.
+
+(CEA = Commissariat à l'énergie atomique et aux énergies alternatives)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

content/mm16.rst

+APS March meeting 2016 tutorial
+-------------------------------
+
+This page collects materials for the APS March meeting 2016 tutorial “Introduction to Computational Quantum Nanoelectronics” (`announcement <http://www.aps.org/meetings/march/events/tutorials.cfm#t10>`_).
+The tutorial consists of a set of `Jupyter <http://jupyter.org/>`_ notebooks that combine demonstrations and explainations with exercises.  These materials are made available under a `simplified BSD license <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016/blob/master/LICENSE>`_.
+
+* `Run the tutorial directly in your web browser <http://mybinder.org/repo/kwant-project/kwant-tutorial-2016/>`_.  The Python environment and Kwant will run on a server provided by the `Binder service <http://mybinder.org/>`_.
+* `Download everything <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016/repository/archive.zip?ref=master>`_ as a single zip archive.  Kwant 1.2 or newer is required to execute the notebooks.
+* `Browse the git repository <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016>`_.

content/paper.rst

+Kwant reference
+---------------
+
+C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal,
+*Kwant: a software package for quantum transport*,
+`New J. Phys. 16, 063065 (2014)
+<http://iopscience.iop.org/1367-2630/16/6/063065/article>`_.

content/tinyarray.rst

+This page has been moved to https://gitlab.kwant-project.org/kwant/tinyarray

docker/Dockerfile

+# Use for building and deploying Kwant website
+
+FROM ubuntu:16.04
+MAINTAINER Kwant authors <authors@kwant-project.org>
+
+RUN apt-get update -y && apt-get install -y python3-pip git libjpeg-dev zlib1g-dev libxml2-dev libxslt1-dev
+RUN pip3 install nikola jinja2 webassets feedparser