Commit cc0f2f82 authored by Christoph Groth's avatar Christoph Groth
Browse files

rewrite CITING (former ACKNOWLEDGEMENTS), write CONTRIBUTE

parent 50ba826c
==========================
Suggested acknowledgements
==========================
Researchers, please note that even though :doc:`Kwant is Free Software
<license>`, scientific integrity obliges to give appropriate credit. If you
write a scientific paper whose results have been obtained with the help of
Kwant, please acknowledge the work of the :doc:`people that have developed it
<authors>`.
Reference to Kwant paper to be added.
......@@ -20,7 +20,18 @@ Other people that have contributed to Kwant include
* Daniel Jaschke
* Joseph Weston
-------------------------------------------------------------
(To find out who exactly wrote a certain part of Kwant, please use the "blame"
feature of `Git <http://git-scm.com/>`_, the version control system.)
To find out who exactly wrote a certain part of Kwant, please use the "blame"
feature of `git <http://git-scm.com/>`_, the version control system.
We thank Christoph Gohlke for the creation of Windows installers.
Funding
-------
During the development of Kwant 1.0, A. R. Akhmerov and M. Wimmer were supported
by the Dutch Science Foundation NWO/FOM and by the ERC Advanced Investigator
Grant of C. W. J. Beenakker who enthousiastically supported this project.
A. R. Akhmerov was partially supported by a Lawrence Golub fellowship.
C. W. Groth and X. Waintal were supported by the ERC Consolidator Grant MesoQMC.
X. Waintal also acknowledges support from the STREP ConceptGraphene.
==========================
Suggested acknowledgements
==========================
We provide Kwant as free software under a :doc:`BSD license <license>` 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:
TO-BE-FILLED-IN
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 be added to this document later, and will also be available at
`<http://kwant-project.org/citing.html>`_.
Kwant owes much of its current performance to the use of the `MUMPS
<http://graal.ens-lyon.fr/MUMPS/>`_ library for solving systems of sparse linear
equations. If you have done high-performance calculations, we suggest citing
P.R. Amestoy, I.S. Duff, J.S. Koster, J.Y. L’Excellent, SIAM. J. Matrix Anal. &
Appl. 23 (1), 15 (2001).
Finally, if you use the routine for generation of circular ensembles of random
matrices, please cite F. Mezzadri, Notices Am. Math. Soc. 54, 592 (2007).
=====================
Contributing to Kwant
=====================
We view Kwant as not just a package with fixed functionality, but also as a
framework to implement 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 planning to extend it.
We welcome both external contributions that are well-integrated with Kwant's
core functionality, such as new solvers type, or algorithms for calculation of
other observables, as well as code modules that are relatively independent but
useful with Kwant (such as the random matrix theory module `kwant.rmt`).
The complete development history of Kwant is `publicly available
<http://git.kwant-project.org/kwant>`_. Any external contribution will be
clearly marked as such, and papers where it is described (if any) will be
properly mentioned. Contact us if you are interested in submitting a
contribution.
Technical advice
----------------
We use the version control system `Git <http://git-scm.com/>`_ to coordinate the
development of Kwant. If you are new to Git, we invite you to learn its
basics. (There's a plethora of information available on the Web.)
It is best to base your development on the latest version of Kwant. ::
git clone http://git.kwant-project.org/kwant
To work on Kwant itself it is useful to build it in-place so that it does not
have to be re-installed after each change. This can be done with the following
command ::
python setup.py build_ext -i
The ``kwant`` subdirectory of the source distribution will be thus turned into
a proper Python package that can be imported. To be able to import Kwant from
within Python, one can either work in the root directory of the distribution
(where the subdirectory ``kwant`` is located), or make a (symbolic) link from
somewhere in the Python search path to the the package subdirectory.
Some things to keep in mind:
* Please keep the code consistent by adhering to the prevailing naming and
formatting conventions. We generally follow the `"Style Guide for Python
Code" <http://www.python.org/dev/peps/pep-0008/>`_ For docstrings, we follow
`NumPy's "Docstring Standard"
<http://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ and
`Python's "Docstring Conventions"
<http://www.python.org/dev/peps/pep-0257/>`_.
* Write tests for all the important functionality you add. Be sure not to
break existing tests.
......@@ -485,34 +485,3 @@ Because of some quirks of how Sphinx works, it might be necessary to execute
``make clean`` between building HTML and PDF documentation. If this is not
done, Sphinx may mistakenly use PNG files for PDF output or other problems may
appear.
Hacking
=======
To work on Kwant itself it is useful to build it in-place. This can be done
with the following command ::
python setup.py build_ext -i
The ``kwant`` subdirectory of the source distribution will be thus turned into
a proper python package which can be imported. To be able to import Kwant from
within python, one can either work in the root directory of the distribution
(where the subdirectory ``kwant`` is located), or make a (symbolic) link from
somewhere in the Python search path to the the package subdirectory.
Some conventions to keep in mind:
* Write tests for all the important functionality you add. Be sure not to
break existing tests.
* Please keep the code consistent by adhering to the prevailing naming and
formatting conventions. We generally follow the `"Style Guide for Python
Code" <http://www.python.org/dev/peps/pep-0008/>`_ For docstrings, we follow
`NumPy's "Docstring Standard"
<http://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ and
`Python's "Docstring Conventions"
<http://www.python.org/dev/peps/pep-0257/>`_.
Several modules are written in `Cython <http://cython.org/>`_ (.pyx file name
extension). You will need Cython if you want to modify them.
......@@ -7,5 +7,5 @@ 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, and ACKNOWLEDGEMENTS in this
directory.
See also the files INSTALL, LICENSE, AUTHORS, CITING, and CONTRIBUTE
in this directory.
.. include:: ../../../ACKNOWLEDGEMENTS
.. include:: ../../../CITING
.. include:: ../../../CONTRIBUTE
......@@ -8,5 +8,6 @@ Preliminaries
whatsnew/index
install
authors
acknowledgements
citing
license
contribute
Supports Markdown
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