Commit c6e82aa6 authored by Christoph Groth's avatar Christoph Groth

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

parent db933bc0
Kwant is a Python package for numerical quantum transport calculations. It
exposes the natural concepts of the theory of quantum transport (lattices,
symmetries, electrodes, orbital/spin/electron-hole degrees of freedom) in a
simple and transparent way. Kwant offers direct support for calculations of
transport properties (conductance, noise, scattering matrix), dispersion
relations, modes, wave functions, various Green’s functions, and
out-of-equilibrium local quantities. Other computations involving tight-binding
Hamiltonians can be implemented easily.
See also the files INSTALL, LICENSE, AUTHORS, CITING, and CONTRIBUTE
in this directory.
Kwant is a free (open source) 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 than other available codes, even those entirely written in the
low level FORTRAN and C/C++ languages.
Tight-binding models can describe a vast variety of systems and phenomena in
quantum physics. Therefore, Kwant can be used to simulate
* metals,
* graphene,
* topological insulators,
* quantum Hall effect,
* superconductivity,
* spintronics,
* molecular electronics,
* any combination of the above, and many other things.
Kwant can calculate
* transport properties (conductance, noise, scattering matrix),
* dispersion relations,
* modes,
* wave functions,
* various Green’s functions,
* out-of-equilibrium local quantities.
Other computations involving tight-binding Hamiltonians can be implemented
easily.
See the `Kwant web site <http://kwant-project.org/>`_ for the latest version. A
`mailing list <http://kwant-project.org/community>`_ is available for
discussions, questions, and reporting bugs. The development of Kwant can be
followed via the `public git repository <http://git.kwant-project.org/kwant>`_.
See also the files INSTALL.rst, LICENSE.rst, AUTHORS.rst, CITING.rst, and
CONTRIBUTE.rst in this directory.
A note for users of Microsoft Windows
-------------------------------------
To read the text files in this directory (README, LICENSE, INSTALL, etc.),
right-click, choose "Open", and open with "WordPad". ("Notepad" will not
To read the text files in this directory (README.rst, LICENSE.rst, INSTALL.rst,
etc.), right-click, choose "Open", and open with "WordPad". ("Notepad" will not
display the files properly.)
About Kwant
===========
.. include:: ../../../README
:end-before: See also the files
.. include:: ../../../README.rst
:end-before: See the
.. include:: ../../../AUTHORS
.. include:: ../../../AUTHORS.rst
.. include:: ../../../CITING
.. include:: ../../../CITING.rst
.. include:: ../../../CONTRIBUTE
.. include:: ../../../CONTRIBUTE.rst
.. include:: ../../../INSTALL
.. include:: ../../../INSTALL.rst
.. include:: ../../../LICENSE
.. include:: ../../../LICENSE.rst
......@@ -9,7 +9,8 @@
# http://kwant-project.org/authors.
CONFIG_FILE = 'build.conf'
README_FILE = 'README'
README_FILE = 'README.rst'
README_END_BEFORE = 'See also the files'
STATIC_VERSION_FILE = 'kwant/_static_version.py'
REQUIRED_CYTHON_VERSION = (0, 17, 1)
NO_CYTHON_OPTION = '--no-cython'
......@@ -75,7 +76,7 @@ class kwant_build_ext(build_ext):
print >>sys.stderr, \
"""{0}
The compilation of Kwant has failed. Please examine the error message
above and consult the installation instructions in README.
above and consult the installation instructions in README.rst.
You might have to customize {1}.
{0}
Build configuration was:
......@@ -281,9 +282,11 @@ def long_description():
try:
with open(README_FILE) as f:
for line in f:
if line == "\n":
if line.startswith(README_END_BEFORE):
break
text.append(line.rstrip())
while text[-1] == "":
text.pop()
except:
return ''
return '\n'.join(text)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment