Skip to content
Snippets Groups Projects
Commit 806f1c73 authored by Anton Akhmerov's avatar Anton Akhmerov
Browse files

tutorial -> documentation in doc/index; add section to /citing, typo fix

parent 179536c0
No related branches found
No related tags found
No related merge requests found
Citing kwant Citing Kwant
============ ============
We provide Kwant as free software under a `BSD license </license.html>`_ as a 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 service to the physics community. If you have used Kwant for work that has
to a scientific publication, please mention this explicitly in the text body. lead to a scientific publication, please mention the fact that you used it
In addition, we ask you to cite the main paper that introduces Kwant: explicitly in the text body. In addition, we ask you to cite the main paper
that introduces Kwant:
The reference will be provided here once it is available (soon). The reference will be provided here once it is available (soon).
Other references we ask you to consider
---------------------------------------
If you have profited from the quantum transport functionality of Kwant, please If you have profited from the quantum transport functionality of Kwant, please
also cite the upcoming paper that describes the relevant algorithms. The also cite the upcoming paper that describes the relevant algorithms. The
reference will also be added here once it is available. reference will also be added here once it is available.
......
Kwant documentation Kwant documentation
=================== ===================
The two available resources for learning Kwant are its tutorial, and the paper The two available resources for learning Kwant are its documentation, and the
inctroducing Kwant structure and design. The tutorial is hands-on, and mainly paper inctroducing Kwant structure and design. The documentation contains
explains how to use Kwant and its various features. The paper on the other tutorial and package reference. The tutorial part of the documentation is
hand presents a more general perspective, that is useful to kwow for extending hands-on, and mainly explains how to use Kwant and its various features. The
Kwant functionality. package reference provides detailed description of every Kwant
component. Finally, the paper presents a more general
perspective, that is useful to kwow for extending Kwant functionality.
Kwant tutorial: Kwant documentation:
* `browse online </doc/1.0>`_ * `browse online </doc/1.0>`_
* `download pdf <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.pdf>`_ * `download pdf <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.pdf>`_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment