From 7b1a9009f725d8d4c010c4abcd1ca345415a3e73 Mon Sep 17 00:00:00 2001
From: Anton Akhmerov <anton.akhmerov@gmail.com>
Date: Sun, 8 Sep 2013 23:58:15 +0200
Subject: [PATCH] update the website with release-final info
---
content/authors.txt | 16 +++++++
content/citing.txt | 2 +-
content/community.txt | 9 ++++
content/contact.txt | 12 ------
content/contribute.txt | 39 ++++++++++-------
content/install.txt | 95 +++++++++++++++++++++++++-----------------
content/license.txt | 32 ++++++++++++++
content/paper.txt | 4 ++
templates/base.mako | 3 +-
9 files changed, 143 insertions(+), 69 deletions(-)
create mode 100644 content/authors.txt
create mode 100644 content/community.txt
delete mode 100644 content/contact.txt
create mode 100644 content/license.txt
create mode 100644 content/paper.txt
diff --git a/content/authors.txt b/content/authors.txt
new file mode 100644
index 0000000..9678bf1
--- /dev/null
+++ b/content/authors.txt
@@ -0,0 +1,16 @@
+Contact
+=======
+
+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/>`_ (Leiden
+ University)
+* `Anton R. Akhmerov <http://antonakhmerov.org>`_ (Delft University)
+* `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.
diff --git a/content/citing.txt b/content/citing.txt
index 9f7d1a9..40bf6c9 100644
--- a/content/citing.txt
+++ b/content/citing.txt
@@ -1,7 +1,7 @@
Citing kwant
============
-We provide Kwant as free software under a BSD license 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
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:
diff --git a/content/community.txt b/content/community.txt
new file mode 100644
index 0000000..f60238b
--- /dev/null
+++ b/content/community.txt
@@ -0,0 +1,9 @@
+Kwant mailing list
+==================
+
+The mailing list kwant-discuss@kwant-project.org serves as the main platform
+for discussion of various aspects of Kwant: reporting bugs, asking questions,
+and discussing furhter development. The mailing list archives are available
+through `gmane <http://gmane.org/gmane.comp.python.kwant.discuss>`_
+
+New releases of Kwant are announced through kwant-announce@kwant-project.org.
diff --git a/content/contact.txt b/content/contact.txt
deleted file mode 100644
index b052b1d..0000000
--- a/content/contact.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Contact
-=======
-
-The principal developers of kwant are:
-
-* Christoph W. Groth (SPSMS-INAC-CEA Grenoble)
-* Michael Wimmer (Leiden University)
-* Anton R. Akhmerov (Harvard University, Leiden University)
-* Xavier Waintal (SPSMS-INAC-CEA Grenoble)
-
-If you have any questions regarding kwant, or find a bug, please email to
-authors@kwant-project.org.
diff --git a/content/contribute.txt b/content/contribute.txt
index 868100c..059a969 100644
--- a/content/contribute.txt
+++ b/content/contribute.txt
@@ -7,27 +7,33 @@ 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.
-External contributions to Kwant are highly welcome. You can help to advance the
-project not only by writing code, but also by reporting bugs, and
-fixing/improving the documentation. A mailing list TODO: add link (also
-usable through a web interface (TODO: add link) ) is available for discussions.
+External contributions to Kwant are highly welcome. You can help to advance
+the project not only by writing code, but also by reporting bugs, and
+fixing/improving the documentation. A `mailing list
+</community.html>`_ is available for discussions.
If you have some code that works well with Kwant, or extends it in some useful
way, please consider sharing it. Any external contribution will be clearly
-marked as such, and relevant papers will be added to the list of `suggested
-acknowledgements </citing.html>`_. The complete development history is
-available through a `web interface <http://git.kwant-project.org/kwant>`_.
-
-Reporiting bugs
----------------
+marked as such, and relevant papers will be added to the list of
+`suggested acknowledgements </citing.html>`_. The complete development history
+is also made available through a `web interface
+<http://git.kwant-project.org/kwant>`_. If you plan to contribute, it is best
+to coordinate with us in advance either through the `mailing list
+</community.html>`__, or directly by `email
+<mailto:authors@kwant-project.org>`_ for matters that you prefer to not discuss
+publicly.
+
+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 whether the problem
-is already known by searching the mailing list. (TODO: tell how).
+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 whether
+the problem is already known by searching the `mailing list
+</community.html>`__.
If the problem is not known yet, please email a bug report to the `Kwant mailing
-list <mailto:kwant-discuss@kwant-project.org>`_. A report should contain:
+list </community.html>`__. A report should contain:
* The versions of software you are using (Kwant, Python, operating system, etc.)
@@ -49,8 +55,9 @@ It is best to base your work on the latest version of Kwant::
git clone http://git.kwant-project.org/kwant
-Then you can modify the code, and build Kwant and the documentation as described
-in the `installation instructions </install.html>`_.
+Then you can modify the code, and build Kwant and the documentation as
+described in the `build instructions
+</docs/pre/install.html#building-and-installing-from-source>`_.
Some things to keep in mind:
diff --git a/content/install.txt b/content/install.txt
index 24a2253..294e8aa 100644
--- a/content/install.txt
+++ b/content/install.txt
@@ -1,8 +1,10 @@
+=======
Install
=======
-Kwant can be installed either using some prepared packages (on GNU/Linux, Mac OS
-X, and Windows), or it can be built and installed from source.
+Kwant can be installed either using prepared packages (Debian and Ubuntu
+variants of GNU/Linux, Mac OS X, and Windows), or it can be built and installed
+from source.
In general, installation from packages is advisable, especially for novice
users. Expert users may find it helpful to build Kwant from source, as this
@@ -10,50 +12,66 @@ will also allow them to customize Kwant to use certain optimized versions of
libraries.
Ubuntu (and derivatives)
-------------------------
+========================
Execute the following commands::
- sudo apt-add-repository ppa:kwant-project/ppa
- sudo apt-get update
- sudo apt-get install python-kwant
+ sudo apt-add-repository ppa:kwant-project/ppa
+ sudo apt-get update
+ sudo apt-get install python-kwant python-kwant-doc
-This should provide Kwant for all the versions of Ubuntu >= 12.04.
+This should provide Kwant for all versions of Ubuntu >= 12.04. The HTML
+documentation will be installed locally in the directory
+``/usr/share/doc/python-kwant-doc``.
-Debian GNU/Linux (and derivatives)
-----------------------------------
+Debian (and derivatives)
+========================
The easiest way to install Kwant on a Debian system is using the pre-built
packages we provide. Our packages are known to work with Debian "wheezy" and
Debian "jessie", but they may also work on many other recent Debian-derived
-sytems as well. (For example the following works with recent Ubuntu
-installations as well.)
+sytems as well. (For example, the following works with recent Ubuntu versions.)
The lines prefixed with ``sudo`` have to be run as root.
1. Add the following lines to ``/etc/apt/sources.list``::
- deb http://kwant-project.org/debian/ stable main
- deb-src http://kwant-project.org/debian/ stable main
+ deb http://downloads.kwant-project.org/debian/ stable main
+ deb-src http://downloads.kwant-project.org/debian/ stable main
2. (Optional) Add the OpenPGP key used to sign the repositories by executing::
sudo apt-key adv --keyserver pgp.mit.edu --recv-key C3F147F5980F3535
- (Feel free to verify the validity of this key using the web of trust!)
-
3. Update the package data, and install Kwant::
sudo apt-get update
sudo apt-get install python-kwant python-kwant-doc
- The `python-kwant-doc` package is optional and installs the HTML
+ The ``python-kwant-doc`` package is optional and installs the HTML
documentation of Kwant in the directory ``/usr/share/doc/python-kwant-doc``.
+Should the last command (``apt-get install``) fail due to unresolved
+dependencies, you can try to build and install your own packages, which is
+surprisingly easy::
+
+ cd /tmp
+
+ sudo apt-get build-dep tinyarray
+ apt-get source --compile tinyarray
+ sudo dpkg -i python-tinyarray_*.deb
+
+ sudo apt-get build-dep kwant
+ apt-get source --compile kwant
+ sudo dpkg -i python-kwant_*.deb python-kwant-doc_*.deb
+
+This method should work for virtually all Debian-derived systems, even on exotic
+architectures.
+
Windows
--------
+=======
There are multiple distributions of scientific Python software for Windows that
provide the prerequisites for Kwant. We recommend to use the packages kindly
@@ -71,7 +89,7 @@ provided by Christoph Gohlke. To install Kwant on Windows
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_. Once again you should choose
the architecture that is appropriate for your system. ("win32" means 32-bit,
"amd64" means 64-bit -- even if you have a processor from Intel.) If the
- download from Gohlke's site is slow, try to download from our `mirror
+ download from Gohlke's site is slow, try to download from `our mirror
<http://downloads.kwant-project.org/gohlke-mirror/>`_.
You may see a warning that says "The publisher could not be verified. Do you
@@ -79,7 +97,7 @@ provided by Christoph Gohlke. To install Kwant on Windows
Mac OSX
--------
+=======
There is a number of different package managers for bringing software
from the Unix/Linux world to Mac OSX. Since the community is quite
@@ -87,7 +105,7 @@ split, we provide Kwant and its dependencies both via the `MacPorts
<http://www.macports.org>`_ and `homebrew <http://brew.sh>`_ systems.
Mac OSX: MacPorts
------------------
+=================
MacPorts is a full-fledged package manager that recreates a whole Linux-like
environment on your Mac. It requires little choices to be made by the user,
@@ -102,9 +120,9 @@ In order to install Kwant, you have to
few prerequisites, namely
* the Xcode developer tools (compiler suite for Mac OSX) from
- `<http://developer.apple.com/downloads>`_. You need an Apple ID to
- download: Note that if you have one already from using the App store
- on the Mac/Ipad/Iphone/... you can use this one. You will also need the
+ `<http://developer.apple.com/downloads>`_. You will need an Apple ID to
+ download. Note that if you have one already from using the App store
+ on the Mac/Ipad/Iphone/... you can use that one. You will also need the
command line tools: Within Xcode 4, you have to download them by going to
`Xcode->Preferences`, click on `Download`, go to `Components`,
select `Command Line Tools` and click on `Install`. Alternatively, you can
@@ -148,7 +166,7 @@ Notes:
Mac OS X: homebrew
-------------------
+==================
homebrew is a recent addition to the package managers on Mac OSX. It is
more lightweight, tries to be as minimalistic as possible and give the user
@@ -169,18 +187,17 @@ you are safe.
installed, in particular
* the Xcode developer tools (compiler suite for Mac OSX) from
- `<http://developer.apple.com/downloads>`_. You need an Apple ID to
- download: Note that if you have one already from using the App store
- on the Mac/Ipad/Iphone/... you can use this one. Note that downloading
- the command line tools (not the full Xcode suite) suffices. If you have
- the full Xcode suite installed, you might need to download the command
- line tools manually if you have version 4 or higher. In this case
- go to `Xcode->Preferences`, click on `Download`, go to `Components`,
- select `Command Line Tools` and click on `Install`.
- * although `brew doctor` might not complain about it right away,
- while we're at it, you should also install the X11 server from the
- `XQuartz project <http://xquartz.macosforge.org>`_ if you have Mac
- OSX 10.8 or higher.
+ `<http://developer.apple.com/downloads>`_. You will need an Apple ID to
+ download. Note that if you have one already from using the App store on the
+ Mac/Ipad/Iphone/... you can use that one. Downloading the command line
+ tools (not the full Xcode suite) is sufficient. If you have the full Xcode
+ suite installed, you might need to download the command line tools manually
+ if you have version 4 or higher. In this case go to `Xcode->Preferences`,
+ click on `Download`, go to `Components`, select `Command Line Tools` and
+ click on `Install`.
+ * although `brew doctor` might not complain about it right away, while we're
+ at it, you should also install the X11 server from the `XQuartz project
+ <http://xquartz.macosforge.org>`_ if you have Mac OSX 10.8 or higher.
3. Add permanently ``/usr/local/bin`` before ``/usr/bin/`` in the ``$PATH$``
environment variable of your shell, for example by adding ::
@@ -221,7 +238,7 @@ Notes:
Building and installing from source
------------------------------------
+===================================
-See complete `building instructions
-</docs/build/html/pre/install.html#building-and-installing-from-source>`_.
+See complete `build instructions
+</docs/pre/install.html#building-and-installing-from-source>`_.
diff --git a/content/license.txt b/content/license.txt
new file mode 100644
index 0000000..7aae24c
--- /dev/null
+++ b/content/license.txt
@@ -0,0 +1,32 @@
+Kwant license
+=============
+
+(This license applies to all files within Kwant distribution except those
+within the ``doc/sphinxext`` subdirectory for which
+``doc/sphinxext/LICENSE.txt`` applies.)
+
+Copyright 2011-2013 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.
diff --git a/content/paper.txt b/content/paper.txt
new file mode 100644
index 0000000..5ab03d8
--- /dev/null
+++ b/content/paper.txt
@@ -0,0 +1,4 @@
+Kwant reference
+---------------
+
+The ideas behind Kwant design are described in http://arxiv.org/abs/1308:XXXX
diff --git a/templates/base.mako b/templates/base.mako
index 3ce526f..78cbb45 100644
--- a/templates/base.mako
+++ b/templates/base.mako
@@ -21,7 +21,8 @@
<li><a href="/docs/">documentation</a></li>
<li><a href="/citing.html">citing</a></li>
<li><a href="/contribute.html">contribute</a></li>
- <li><a href="/contact.html">contact</a></li>
+ <li><a href="/community.html">community</a></li>
+ <li><a href="/authors.html">authors</a></li>
</ul>
</div>
--
GitLab