From 806f1c738a9bf7b6263c49a8fe52604d6013d236 Mon Sep 17 00:00:00 2001 From: Anton Akhmerov <anton.akhmerov@gmail.com> Date: Wed, 11 Sep 2013 17:30:16 +0200 Subject: [PATCH] tutorial -> documentation in doc/index; add section to /citing, typo fix --- content/citing.txt | 12 ++++++++---- content/doc/index.txt | 14 ++++++++------ 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/content/citing.txt b/content/citing.txt index 40bf6c9..88ee365 100644 --- a/content/citing.txt +++ b/content/citing.txt @@ -1,13 +1,17 @@ -Citing kwant +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 this explicitly in the text body. -In addition, we ask you to cite the main paper that introduces Kwant: +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. In addition, we ask you to cite the main paper +that introduces Kwant: 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 also cite the upcoming paper that describes the relevant algorithms. The reference will also be added here once it is available. diff --git a/content/doc/index.txt b/content/doc/index.txt index 6845d5f..2b68d8a 100644 --- a/content/doc/index.txt +++ b/content/doc/index.txt @@ -1,13 +1,15 @@ Kwant documentation =================== -The two available resources for learning Kwant are its tutorial, and the paper -inctroducing Kwant structure and design. The tutorial is hands-on, and mainly -explains how to use Kwant and its various features. The paper on the other -hand presents a more general perspective, that is useful to kwow for extending -Kwant functionality. +The two available resources for learning Kwant are its documentation, and the +paper inctroducing Kwant structure and design. The documentation contains +tutorial and package reference. The tutorial part of the documentation is +hands-on, and mainly explains how to use Kwant and its various features. The +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>`_ * `download pdf <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.pdf>`_ -- GitLab