GitList
Browse code

update links to gitlab

Christoph Groth authored on 08/12/2015 15:44:09
Showing 1 changed files
README.rst
History View file @ c7ed233
... ... 
@@ -28,10 +28,14 @@ Kwant can calculate
28 28 
 Other computations involving tight-binding Hamiltonians can be implemented
29 29 
 easily.
30 30
31 
-See the `Kwant web site <http://kwant-project.org/>`_ for the latest version.  A
32 
-`mailing list <http://kwant-project.org/community>`_ is available for
33 
-discussions, questions, and reporting bugs. The development of Kwant can be
34 
-followed via the `public git repository <http://git.kwant-project.org/kwant>`_.
31 
+See the `Kwant web site <http://kwant-project.org/>`_ for the latest stable
32 
+version.  The current development version is available via the `Kwant gitlab
33 
+instance <https://gitlab.kwant-project.org/kwant/kwant>`_.  Contributions are
34 
+welcome.
35 
+
36 
+A `mailing list <http://kwant-project.org/community>`_ exists for general
37 
+discussions related to Kwant.  Please report bugs and other issues using the
38 
+`issue tracker <https://gitlab.kwant-project.org/kwant/kwant/issues>`_.
35 39
36 40 
 See also in this directory: `<INSTALL.rst>`_, `<LICENSE.rst>`_, `<AUTHORS.rst>`_,
37 41 
 `<CITING.rst>`_, `<CONTRIBUTE.rst>`_.
Browse code

README.rst: link to local files

Christoph Groth authored on 04/02/2015 23:41:43
Showing 1 changed files
README.rst
History View file @ 31f7674
... ... 
@@ -33,5 +33,5 @@ See the `Kwant web site <http://kwant-project.org/>`_ for the latest version.  A
33 33 
 discussions, questions, and reporting bugs. The development of Kwant can be
34 34 
 followed via the `public git repository <http://git.kwant-project.org/kwant>`_.
35 35
36 
-See also the files INSTALL.rst, LICENSE.rst, AUTHORS.rst, CITING.rst, and
37 
-CONTRIBUTE.rst in this directory.
36 
+See also in this directory: `<INSTALL.rst>`_, `<LICENSE.rst>`_, `<AUTHORS.rst>`_,
37 
+`<CITING.rst>`_, `<CONTRIBUTE.rst>`_.
Browse code

add rst-extension to README (and similar files), expand README.rst into a PyPI-"homepage"

Christoph Groth authored on 03/02/2015 17:47:59
Showing 1 changed files
README.rst
History View file @ c6e82aa
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,37 @@
1 
+Kwant is a free (open source) Python package for numerical calculations on
2 
+tight-binding models with a strong focus on quantum transport. It is designed to
3 
+be flexible and easy to use. Thanks to the use of innovative algorithms, Kwant
4 
+is often faster than other available codes, even those entirely written in the
5 
+low level FORTRAN and C/C++ languages.
6 
+
7 
+Tight-binding models can describe a vast variety of systems and phenomena in
8 
+quantum physics. Therefore, Kwant can be used to simulate
9 
+
10 
+* metals,
11 
+* graphene,
12 
+* topological insulators,
13 
+* quantum Hall effect,
14 
+* superconductivity,
15 
+* spintronics,
16 
+* molecular electronics,
17 
+* any combination of the above, and many other things.
18 
+
19 
+Kwant can calculate
20 
+
21 
+* transport properties (conductance, noise, scattering matrix),
22 
+* dispersion relations,
23 
+* modes,
24 
+* wave functions,
25 
+* various Green’s functions,
26 
+* out-of-equilibrium local quantities.
27 
+
28 
+Other computations involving tight-binding Hamiltonians can be implemented
29 
+easily.
30 
+
31 
+See the `Kwant web site <http://kwant-project.org/>`_ for the latest version.  A
32 
+`mailing list <http://kwant-project.org/community>`_ is available for
33 
+discussions, questions, and reporting bugs. The development of Kwant can be
34 
+followed via the `public git repository <http://git.kwant-project.org/kwant>`_.
35 
+
36 
+See also the files INSTALL.rst, LICENSE.rst, AUTHORS.rst, CITING.rst, and
37 
+CONTRIBUTE.rst in this directory.