Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • kwant/website
  • jbweston/website
  • basnijholt/website
  • r-j-skolasinski/website
  • marwahaha/website
5 results
Show changes
Commits on Source (90)
Showing
with 895 additions and 577 deletions
image: kwant/website-deploy
before_script:
- nikola build
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
- eval $(ssh-agent -s)
test_deploy:
script:
- mkdir -p ~/.ssh && ssh-keyscan kwant-project.org >> ~/.ssh/known_hosts
- echo $TEST_WEBSITE_KEY > deploy_key && sed -i 's/\r /\n/g' deploy_key && chmod 600 deploy_key
- echo "$TEST_WEBSITE_KEY" | tr -d '\r' | ssh-add -
- nikola deploy
except:
- master
master_deploy:
script:
- mkdir -p ~/.ssh && ssh-keyscan kwant-project.org >> ~/.ssh/known_hosts
- echo $MASTER_WEBSITE_KEY > deploy_key && sed -i 's/\r /\n/g' deploy_key && chmod 600 deploy_key
- nikola deploy
- echo "$MASTER_WEBSITE_KEY" | tr -d '\r' | ssh-add -
- nikola deploy master
only:
- master
......@@ -32,59 +32,10 @@ BLOG_DESCRIPTION = "Kwant project website" # (translatable)
#
# Currently supported languages are:
#
# en English
# ar Arabic
# az Azerbaijani
# bg Bulgarian
# ca Catalan
# cs Czech [ALTERNATIVELY cz]
# da Danish
# de German
# el Greek [NOT gr]
# eo Esperanto
# es Spanish
# et Estonian
# eu Basque
# fa Persian
# fi Finnish
# fr French
# hi Hindi
# hr Croatian
# id Indonesian
# it Italian
# ja Japanese [NOT jp]
# ko Korean
# nb Norwegian Bokmål
# nl Dutch
# pl Polish
# pt_br Portuguese (Brasil)
# ru Russian
# sk Slovak
# sl Slovene
# sr Serbian (Cyrillic)
# sv Swedish
# tr Turkish [NOT tr_TR]
# uk Ukrainian
# ur Urdu
# zh_cn Chinese (Simplified)
#
# If you want to use Nikola with a non-supported language you have to provide
# a module containing the necessary translations
# (cf. the modules at nikola/data/themes/base/messages/).
# If a specific post is not translated to a language, then the version
# in the default language will be shown instead.
# What is the default language?
DEFAULT_LANG = "en"
# What other languages do you have?
# The format is {"translationcode" : "path/to/translation" }
# the path will be used as a prefix for the generated pages location
TRANSLATIONS = {
DEFAULT_LANG: "",
# Example for another language:
# "es": "./es",
}
# What will translated input files be named like?
......@@ -123,6 +74,10 @@ TRANSLATIONS_PATTERN = "{path}.{lang}.{ext}"
NAVIGATION_LINKS = {
DEFAULT_LANG: (
("/about.html", "<i class='glyphicon glyphicon-info-sign visible-xs-inline-block'></i>"
"<span class='hidden-xs'>about</span>"),
("/blog/index.html", "<i class='glyphicon glyphicon-bullhorn visible-xs-inline-block'></i>"
"<span class='hidden-xs'>blog</span>"),
("/install.html", "<i class='glyphicon glyphicon-download visible-xs-inline-block'></i>"
"<span class='hidden-xs'>install</span>"),
("/doc", "<i class='glyphicon glyphicon-book visible-xs-inline-block'></i>"
......@@ -157,7 +112,7 @@ TIMEZONE = "UTC"
# Date format used to display post dates.
# (str used by datetime.datetime.strftime)
# DATE_FORMAT = '%Y-%m-%d %H:%M'
DATE_FORMAT = '%Y-%m-%d'
# Date format used to display post dates, if local dates are used.
# (str used by moment.js)
......@@ -208,7 +163,9 @@ TIMEZONE = "UTC"
# just independent HTML pages.
#
POSTS = () # No blog entries yet.
POSTS = (
("posts/*.rst", "", "post.tmpl"),
)
PAGES = (
("content/*.rst", "", "story.tmpl"),
......@@ -412,10 +369,28 @@ REDIRECTIONS = []
# to `nikola deploy`. If no arguments are specified, a preset
# named `default` will be executed. You can use as many presets
# in a `nikola deploy` command as you like.
# rsync is used to send documentation to our web servers: we never send any
# secret information, and using 'ssh-keyscan' causes the CI server's IP to
# be blacklisted, so we specify "StrictHostKeyChecking=no".
SSH_OPTS = ["StrictHostKeyChecking=no", "UserKnownHostsFile=/dev/null"]
SSH_OPTS = ' '.join('-o ' + opt for opt in SSH_OPTS)
DEPLOY_COMMANDS = {
'default': [
"rsync -rlv -e 'ssh -i deploy_key' --delete --filter 'P doc/*' output/* kwant@kwant-project.org:",
"rsync -lv -e 'ssh -i deploy_key' htaccess-apache kwant@kwant-project.org:/.htaccess",
"rsync -rlv -e 'ssh {}' --delete "
"--filter 'P doc/*' --filter 'P extensions/*' output/* kwant2@iapetus.uberspace.de:"
.format(SSH_OPTS),
"rsync -lv -e 'ssh {}' htaccess-apache kwant2@iapetus.uberspace.de:/.htaccess"
.format(SSH_OPTS),
],
'master': [
"rsync -rlv -e 'ssh {}' --delete "
"--filter 'P doc/*' --filter 'P extensions/*' output/* kwant@fornjot.uberspace.de:"
.format(SSH_OPTS),
"rsync -lv -e 'ssh {}' htaccess-apache kwant@fornjot.uberspace.de:/.htaccess"
.format(SSH_OPTS),
]
}
......@@ -617,7 +592,7 @@ FAVICONS = (
("icon", "/kwant_icon.png", "32x32"),)
# Show only teasers in the index pages? Defaults to False.
# INDEX_TEASERS = False
INDEX_TEASERS = True
# HTML fragments with the Read more... links.
# The following tags exist and are replaced for you:
......@@ -632,7 +607,7 @@ FAVICONS = (
# }} A literal } (U+007D RIGHT CURLY BRACKET)
# 'Read more...' for the index page, if INDEX_TEASERS is True (translatable)
INDEX_READ_MORE_LINK = '<p class="more"><a href="{link}">{read_more}…</a></p>'
INDEX_READ_MORE_LINK = ''
# 'Read more...' for the RSS_FEED, if RSS_TEASERS is True (translatable)
FEED_READ_MORE_LINK = '<p><a href="{link}">{read_more}…</a> ({min_remaining_read})</p>'
......@@ -833,7 +808,7 @@ COPY_SOURCES = False
# By default, Nikola generates RSS files for the website and for tags, and
# links to it. Set this to False to disable everything RSS-related.
# GENERATE_RSS = True
GENERATE_RSS = True
# By default, Nikola does not generates Atom files for indexes and links to
# them. Generate Atom for tags by setting TAG_PAGES_ARE_INDEXES to True.
......@@ -842,7 +817,7 @@ COPY_SOURCES = False
# RSS_TEASER option. RSS_LINKS_APPEND_QUERY is also respected. Atom feeds
# are generated even for old indexes and have pagination link relations
# between each other. Old Atom feeds with no changes are marked as archived.
# GENERATE_ATOM = False
GENERATE_ATOM = True
# RSS_LINK is a HTML fragment to link the RSS or Atom feeds. If set to None,
# the base.tmpl will use the feed Nikola generates. However, you may want to
......@@ -917,18 +892,18 @@ BODY_END = """
var _paq = _paq || [];
_paq.push(["setDocumentTitle", document.domain + "/" + document.title]);
_paq.push(["setCookieDomain", "*.kwant-project.org"]);
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
_paq.push(["setDomains", ["*.kwant-project.org","*.downloads.kwant-project.org","*.git.kwant-project.org","*.gitlab.kwant-project.org"]]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://piwik.kwant-project.org/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
var u="//piwik.kwant-project.org/";
_paq.push(['setTrackerUrl', u+'piwik.php']);
_paq.push(['setSiteId', 1]);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<noscript><img src="http://piwik.kwant-project.org/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" /></noscript>
<noscript><p><img src="//piwik.kwant-project.org/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code: Analytics are used by us to improve the site, and not sent to anyone. -->
"""
......
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>`_.
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 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>`_.
A list of `Kwant authors </authors>`_ is included in the documentation.
Please only contact the authors directly for matters that cannot be discussed
in public on one of the mailing lists.
General mailing list
--------------------
The `kwant-discuss
<https://mailman-mail5.webfaction.com/listinfo/kwant-discuss>`_ mailing list is
the main public communication platform for anything related to Kwant: questions,
bug reports, discussions, and announcements. You can use it in various ways:
- .. raw:: html
<form class="form-inline" id="searchgmane" method="get" action="http://search.gmane.org/">
<div class="input-group col-md-6">
<input type="text" class="form-control" placeholder="Search query" size=25 name="query" />
<input type="hidden" name="group" value="gmane.comp.science.kwant.user" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" value="Search kwant-discuss" />
</span>
</div>
</form>
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.
- .. raw:: html
<form class="form-inline" method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-discuss">
<div class="input-group col-md-6">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to kwant-discuss" />
</span>
</div>
</form>
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.
… and receive new messages with your regular email. (Use the `kwant-discuss options page <https://mailman-mail5.webfaction.com/options/kwant-discuss>`_ to unsubscribe.)
- Follow the list through a web interface: `kwant-discuss on Gmane <http://dir.gmane.org/gmane.comp.science.kwant.user>`_ or
`kwant-discuss on Mail-archive <https://www.mail-archive.com/kwant-discuss@kwant-project.org/>`_.
Gmane allows to write new messages (action: post) and to reply (action: followup).
Both Gmane and Mail-archive provide RSS feeds.
Mailing list
------------
- Send a message directly to kwant-discuss@kwant-project.org. (If you are not
subscribed, it is not guaranteed that any followups will reach you by email,
so you should ask to be CCed.)
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.
Development list
----------------
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.
Those who are interested (or would like to participate) in the further
development of Kwant are invited to subscribe to the `kwant-devel
<https://mailman-mail5.webfaction.com/listinfo/kwant-devel>`_ mailing list.
This is the place for technical discussions about changes to Kwant.
Please do not send bug reports to this list but rather to kwant-discuss.
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).
Kwant-devel works in the same way as kwant-discuss:
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.
- .. raw:: html
List etiquette :
<form class="form-inline" id="searchgmane" method="get" action="http://search.gmane.org/">
<div class="input-group col-md-6">
<input type="text" class="form-control" placeholder="Search query" size=25 name="query" />
<input type="hidden" name="group" value="gmane.comp.science.kwant.devel" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" value="Search kwant-devel" />
</span>
</div>
</form>
- When asking questions,
`help others to help you <https://stackoverflow.com/help/how-to-ask>`_.
In particular, use the search function before posting.
- .. raw:: html
- When replying, please avoid quoting the complete original message.
Instead, consider
`bottom-posting <https://en.wikipedia.org/wiki/Posting_style#Bottom-posting>`_.
<form class="form-inline" method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-devel">
<div class="input-group col-md-6">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to kwant-devel" />
</span>
</div>
</form>
(Use the `kwant-devel options page <https://mailman-mail5.webfaction.com/options/kwant-devel>`_ to unsubscribe.)
Announcements mailing list
--------------------------
- There exist web interfaces: `kwant-devel on Gmane <http://dir.gmane.org/gmane.comp.science.kwant.devel>`_ and
`kwant-devel on Mail-archive <https://www.mail-archive.com/kwant-devel@kwant-project.org/>`_.
Both provide RSS feeds, Gmane also allows posting through the web interface.
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.
- Message can be sent directly to kwant-devel@kwant-project.org. (If you are not
subscribed, it is not guaranteed that any followups will reach you by email,
so you should ask to be CCed.)
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.
Announcements (low-volume)
--------------------------
This read-only list is reserved for important announcements like new releases of
Kwant. Only a few messages will be sent per year. These announcements will be 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.
Development chat
----------------
- View archives: `kwant-announce on Gmane <http://dir.gmane.org/gmane.comp.science.kwant.announce>`_ or `kwant-announce on Mail-archive <https://www.mail-archive.com/kwant-announce@kwant-project.org/>`_. Both Gmane and Mail-archive provide RSS feeds.
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!
- .. raw:: html
<form method=post class="form-inline" action="https://mailman-mail5.webfaction.com/subscribe/kwant-announce">
<div class="input-group col-md-6">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to the announcements" />
</span>
</div>
</form>
Gitlab instance
---------------
(Use the `kwant-announce options page <https://mailman-mail5.webfaction.com/options/kwant-announce>`_ to unsubscribe.)
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 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.)
- The versions of software you are using: Kwant, Python, operating system, etc.
* A description of the problem, i.e. what exactly goes wrong.
- 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
- Enough information to reproduce the bug, preferably in the form of a simple
script.
......@@ -3,12 +3,9 @@ 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 and, if possible, a shared interface. We have designed it
leaving room for growth, and plan to keep extending it.
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.
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
......@@ -21,9 +18,7 @@ categorized with labels, so that it is possible to view `all the “easy” issu
<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 development
mailing list kwant-devel@kwant-project.org before filing an issue.
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
......@@ -127,18 +122,18 @@ Now you can push your topic branch to your repository::
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-devel@kwant-project.org.
sending a message to kwant-discuss@kwant-project.org.
Method 2: Sending patches to the development mailing list
.........................................................
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-devel@kwant-project.org,
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.
......@@ -162,4 +157,11 @@ Coding style
* 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.
* 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.
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:
<a href="kwant-screencast-2014.html">watch</a>,
<a href="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4" download>download</a>.
Tutorial and Manual
-------------------
* `Browse online </doc/1/>`_,
* `download PDF <http://downloads.kwant-project.org/doc/kwant-doc-1.1.1.pdf>`_,
* `download zipped HTML
<http://downloads.kwant-project.org/doc/kwant-doc-1.1.1.zip>`_ (for reading
without web access).
<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 more systematic way and discusses its design and performance (`New J. Phys. 16, 063065 (2014) <http://iopscience.iop.org/1367-2630/16/6/063065/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>`_).
================
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>`_
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
<div class="workflow-image">
<object type="image/svg+xml" data="kwant-workflow.svgz" class="img-responsive">kwant-workflow.svgz</object>
</div>
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
..............
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
<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
<div id="recent-posts" class="section col-sm-6">
<h2> Recent blog posts </h2>
def disk(pos):
x, y = pos
return x**2 + y**2 < 8**2
lat = kwant.lattice.honeycomb()
sys = kwant.Builder()
sys[lat.shape(disk, (0, 0))] = 0
sys[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
...................
.. post-list::
:stop: 4
.. 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
......................................................
</div>
.. 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>`_.
<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>
This diff is collapsed.
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>`_.
# Use for building and deploying Kwant website
FROM ubuntu:14.04
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
RUN pip3 install nikola jinja2 webassets feedparser
No preview for this file type
......@@ -36,3 +36,12 @@ Redirect 302 /citing /doc/latest/pre/citing
Redirect 302 /cite /doc/latest/pre/citing
Redirect 302 /license /doc/latest/pre/license
Redirect 302 /download /install
# Redirect old tutorial URLs to new ones.
# The tutorial numbers refer to the tutorial enumeration in Kwant 1.2.x
Redirect 302 /doc/1/tutorial/tutorial1 /doc/1/tutorial/first_steps
Redirect 302 /doc/1/tutorial/tutorial2 /doc/1/tutorial/spin_potential_shape
Redirect 302 /doc/1/tutorial/tutorial3 /doc/1/tutorial/spectrum
Redirect 302 /doc/1/tutorial/tutorial4 /doc/1/tutorial/graphene
Redirect 302 /doc/1/tutorial/tutorial5 /doc/1/tutorial/superconductor
Redirect 302 /doc/1/tutorial/tutorial6 /doc/1/tutorial/plotting
.. title: Improved web interface for the mailing list
.. slug: improved-interface-for-mailing-list
.. date: 2020-05-28 20:00:00 UTC
.. category:
.. type: text
The Kwant mailing list has been migrated to a new server that provides a much-improved web interface.
.. TEASER_END
In May 2020, thanks to the friendly people at python.org,
kwant-discuss was migrated to a server running Mailman 3.
The list remains a mailing list (existing subscriptions continue),
but now also offers a modern web interface that is similar to a web forum.
The complete archives were migrated and are now searchable.
Please see the `“community” section </community>`_ of this site for usage information.
The `old address of the list <kwant-discuss@kwant-project.org>`_ remains usable: any messages are simply redirected to the new one.
.. title: List of Kwant extensions added to website
.. slug: kwant-extensions
.. date: 2018-03-28 11:56:55 UTC
.. tags:
.. category:
.. link:
.. description:
.. type: text
We have added a `new section to the website </extensions.html>`_
that showcases useful extensions to Kwant that have been made by members of the
community.
.. TEASER_END
While we welcome contributions to the core Kwant package, we realize that
it can be a lot of work to implement something that is both robust enough
and of sufficiently general interest to be added to Kwant directly.
Nevertheless there is a body of existing software that extends Kwant in ways
that could be useful to others in the Kwant community. We hope that providing
a central place for listing these extensions will make them more discoverable
by others.
If you have extended Kwant in some way, please get in touch via the
`kwant-devel <mailto:kwant-devel@kwant-project.org>`_ mailing list!
Happy Kwanting,
Kwant team
.. title: Kwant adds an FAQ to the documentation
.. slug: kwant-faq-intro
.. date: 2017-06-29 07:07:23 UTC
.. tags:
.. category:
.. link:
.. description:
.. type: text
The Kwant team in Grenoble is currently hosting a masters student, Paul Clisson,
who has taken the initiative and written a "Frequently Asked
Questions" (FAQ) section to complement the existing Kwant tutorial; thanks Paul!
.. TEASER_END
A preliminary version of of the FAQ is already available
`here <https://test.kwant-project.org/doc/doc-faq/tutorial/FAQ>`_. Any and all
user feedback is valuable to us, so tell us what you think! You can either join
the `discussion on the mailing
list <https://www.mail-archive.com/kwant-discuss@kwant-project.org/msg01313.html>`_
or comment on the open `merge
request <https://gitlab.kwant-project.org/kwant/kwant/merge_requests/148>`_ on
the Kwant gitlab.
Happy Kwanting,
Kwant team
.. title: Release of Kwant 1.3
.. slug: release-of-kwant-13
.. date: 2017-05-24 21:17:10 UTC
.. category: release-announcement
.. type: text
After more than one year of development, we are extremely pleased to announce the release of Kwant 1.3.
.. TEASER_END
Kwant 1.3 supports
* discretizing of continuum Hamiltonians,
* calculating and displaying local densities and currents,
* declaring and using symmetries and conservation laws,
* calculating bulk properties using the kernel polynomial method,
* finalizing builders with multiple translational symmetries,
and has many other improvements that are detailed in the `what's new in Kwant 1.3 </doc/1/pre/whatsnew/1.3>`_ document.
The `installation instructions </install.html>`_ have been updated to explain how to install Kwant 1.3 on computers running GNU/Linux, Mac OS, and Windows. Note that thanks to the package manager Conda it is now much easier to install Kwant under Mac OS and on Unix accounts without root privileges.
The new version is practically 100% backwards-compatible with scripts written for previous versions of Kwant 1.x.
The Kwant team is happy to welcome Joseph Weston as a member. We are also grateful to the many contributors without whom this release would not be nearly as good:
* Jörg Behrmann
* Bas Nijholt
* Michał Nowak
* Viacheslav Ostroukh
* Pablo Pérez Piskunow
* Tómas Örn Rosdahl
* Sebastian Rubbert
* Rafał Skolasiński
* Adrien Sorgniard
We would like to hear your feedback at kwant-discuss@kwant-project.org.
.. title: Release of Kwant 1.4
.. slug: release-of-kwant-14
.. date: 2019-03-06 11:46:18 UTC
.. category: release-announcement
.. type: text
We are pleased to announce the release of Kwant 1.4, the result of a year and a half of development.
.. TEASER_END
Highlights of the new release:
* Adding magnetic field to systems, even in complicated cases, is now specially supported.
* The KPM module can now calculate conductivities.
* The `Qsymm library <https://gitlab.kwant-project.org/qt/qsymm>`_ for Hamiltonian symmetry analysis has been integrated.
* The handling of system parameters has been improved and optimized.
* Plotting has been improved, most notably through the addition of a routine that plots densities with interpolation.
* Installing Kwant on Windows is now much easier thanks to Conda packages.
All these and other improvements that are detailed in the `what's new in Kwant 1.4 </doc/1/pre/whatsnew/1.4>`_ document. The new version is practically 100% backwards-compatible with scripts written for previous versions of Kwant 1.x.
The following people contributed code to this release:
* Anton Akhmerov
* Paul Clisson
* Christoph Groth
* Thomas Kloss
* Bas Nijholt
* Pablo Pérez Piskunow
* Tómas Örn Rosdahl
* Rafał Skolasiński
* Dániel Varjas
* Joseph Weston
We would like to hear your feedback at kwant-discuss@kwant-project.org.
.. title: Release of TKwant 1.0
.. slug: release-of-tkwant-1-0
.. date: 2020-09-08 15:00:00 UTC
.. category: release-announcement
.. type: text
We are pleased to announce the first release of TKwant,
a Kwant extension for time-resolved quantum transport.
.. TEASER_END
A system is defined in TKwant in the same way as in Kwant except that some terms in the Hamiltonian may depend on the time parameter. Any system that can be studied in Kwant can be studied with TKwant as well. Typical problems where TKwant can be used include the propagation of voltage pulses, spectroscopy of interferometers, Floquet topological insulators, time resolved Andreev reflection and more.
An introduction to TKwant can be found in `TKwant paper <https://arxiv.org/abs/2009.03132>`_. The software itself and
its tutorials are available on the `TKwant website <https://tkwant.kwant-project.org/>`_.
......@@ -33,6 +33,8 @@ tt, pre {
hyphens: none;
}
/* Navbar styling */
.navbar-nav>li {
display: table-cell;
text-align: center;
......@@ -54,3 +56,108 @@ tt, pre {
display:inline-block;
float:none;
}
/* Index page workflow image styling */
.workflow-image {
padding-bottom: 20px;
}
/* Post list styling */
ul.post-list {
list-style-type: none;
padding-left: 0;
}
li.post-list-item {
padding-bottom: 5px;
}
li.post-list-item .post-item-title {
display: inline;
font-size: 1.1em;
}
/* Kwant uses list */
#kwant-uses-list {
list-style-type: none;
padding-left: 0;
}
#kwant-uses-list > li {
padding: .5em 0 .4em;
border-bottom: 1px solid #caccce;
}
.entry-title {
display: inline;
}
.postindex article.post-text {
border-bottom: 1px solid #caccce;
margin-bottom: .5em;
}
/* documentation links */
ul.docs-list {
padding-left: 0 ;
line-height: 2.5em ;
}
ul.docs-list ul {
padding-left: 20px;
}
ul.docs-list > li {
display: flex ;
}
ul.docs-list > li li {
display:inline ;
}
ul.inline-list {
display: inline ;
padding-left: 10px ;
}
ul.inline-list li{
display: inline ;
}
/* give button-like appearance to links, adapted from python.org */
.button-links a{
display: inline ;
vertical-align: baseline ;
width: auto ;
cursor: pointer ;
margin-bottom: .5em ;
padding: .4em .75em .35em ;
text-align: left ;
white-space: nowrap ;
border-radius: 6px ;
background-color: #eeeeee ;
text-decoration: none ;
}
.button-links a:hover {
background-color: #dddddd ;
}
/* target the "stable version" link. This is a massive hack, but we're
not web developers */
ul.docs-list > li:first-child > ul:nth-child(2) > li:first-child > a {
background-color: #0077cc ;
color: #eeeeee ;
}
ul.docs-list > li:first-child > ul:nth-child(2) > li:first-child > a:hover {
background-color: #0055aa ;
}