From 7fa151f622e92fe7727405a12c21b314ed6dcab3 Mon Sep 17 00:00:00 2001 From: Christoph Groth <christoph.groth@cea.fr> Date: Wed, 2 Jul 2014 22:40:44 +0200 Subject: [PATCH] add screencast, minor other updates --- content/common/kwant.css | 13 +++++++--- content/community.txt | 13 +++++----- content/doc/index.txt | 30 +++++++++++++--------- content/doc/kwant-screencast-2014.html | 35 ++++++++++++++++++++++++++ content/index.txt | 4 +++ 5 files changed, 73 insertions(+), 22 deletions(-) create mode 100644 content/doc/kwant-screencast-2014.html diff --git a/content/common/kwant.css b/content/common/kwant.css index ee5b58e..1f43f6b 100644 --- a/content/common/kwant.css +++ b/content/common/kwant.css @@ -33,9 +33,8 @@ tt, pre { hyphens: none; } -/* The link color is the average color of the Kwant logo. */ a { - color: #045e94; + color: #07c; text-decoration: none; } @@ -77,9 +76,17 @@ h1, h2, h3, h4, h5, h6 { } li { - margin: 0.3em 0 + margin-top: 0.3em; } +li:first-child { + margin-top:0; +} + + +ol.simple, ul.simple { + margin-bottom: 0 } + img { display: block; margin-left: auto; diff --git a/content/community.txt b/content/community.txt index 1bbc66b..5935f17 100644 --- a/content/community.txt +++ b/content/community.txt @@ -4,9 +4,9 @@ Getting help, contributing and reporting problems Mailing list ------------ -The mailing list is (meant to become) the main communication platform for -anything related to Kwant: asking questions, reporting bugs, and discussing -further development. You can use it in various ways: +The 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 @@ -35,12 +35,11 @@ further development. You can use it in various ways: so you should ask to be CCed.) -Announcements of new releases ------------------------------ +Announcements of new releases (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. We recommend every user of -Kwant to subscribe to it in order to stay informed about new developments. +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. .. raw:: html diff --git a/content/doc/index.txt b/content/doc/index.txt index 927ecc3..203ff1e 100644 --- a/content/doc/index.txt +++ b/content/doc/index.txt @@ -1,19 +1,25 @@ -Kwant documentation -=================== +Documentation +============= -Kwant is accompanied by extensive documentation that contains a hands-on -tutorial and a complete reference. In addition, a scientific article exists -that introduces Kwant in a more structured way and discusses its design and -performance. +Screencast +---------- -Kwant documentation (including tutorial): +.. raw:: html -* `browse online </doc/1.0>`_ -* `download PDF <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.pdf>`_ + 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.0>`_, +* `download PDF <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.pdf>`_, * `download zipped HTML <http://downloads.kwant-project.org/doc/kwant-doc-1.0.0.zip>`_ (for reading - without web access) + without web access). -Kwant paper: +Article +------- -* `download PDF <http://downloads.kwant-project.org/doc/kwant-paper.pdf>`__ +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>`_). diff --git a/content/doc/kwant-screencast-2014.html b/content/doc/kwant-screencast-2014.html new file mode 100644 index 0000000..6995f51 --- /dev/null +++ b/content/doc/kwant-screencast-2014.html @@ -0,0 +1,35 @@ +<html> +<head> +<meta name="viewport" content="width=device-width; height=device-height;"> +<title>Kwant screencast</title> +<style media="screen" type="text/css"> +body { +background-color: black; +height: 100%; +width: 100%; +margin: 0; +padding: 0; +} +video { +position: absolute; +top: 0; +right: 0; +bottom: 0; +left: 0; +margin: auto; +max-width: 100%; +max-height: 100%; +} +video:focus { +outline-width: 0; +} +</style> +</head> +<body> +<video controls autoplay> + <source src="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4" type='video/mp4; codecs="avc1.4D401E, mp4a.40.2"'> + <source src="http://downloads.kwant-project.org/doc/kwant-screencast-2014.webm" type='video/webm; codecs="vp8.0, vorbis"'> + Please <a href="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4">download the video manually</a>. +</video> +</body> +</html> diff --git a/content/index.txt b/content/index.txt index 539dd92..fa574bb 100644 --- a/content/index.txt +++ b/content/index.txt @@ -1,6 +1,10 @@ Quantum transport simulations made easy ======================================= +.. raw:: html + + <p><b>Update 2 July 2014: <a href="doc/2014-billiard-screencast.html">watch the Kwant screencast</a>.</b></p> + Kwant is a 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 -- GitLab