diff --git a/ACKNOWLEDGEMENTS b/ACKNOWLEDGEMENTS deleted file mode 100644 index 581d45ab3cd0e3d42b86b5a52c90e1a00e3feafe..0000000000000000000000000000000000000000 --- a/ACKNOWLEDGEMENTS +++ /dev/null @@ -1,11 +0,0 @@ -========================== -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. diff --git a/AUTHORS b/AUTHORS index e8ab87cbedbe0873df2db6bae339e4d023e42213..e40107fa2c357dd115357cf9e501f96561f924c0 100644 --- a/AUTHORS +++ b/AUTHORS @@ -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. diff --git a/CITING b/CITING new file mode 100644 index 0000000000000000000000000000000000000000..c3cc7e91a235b2c42f0a1f35f964c0d54f6d5ec7 --- /dev/null +++ b/CITING @@ -0,0 +1,24 @@ +========================== +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). diff --git a/CONTRIBUTE b/CONTRIBUTE new file mode 100644 index 0000000000000000000000000000000000000000..cf7aacac623164d7050749640a3f98daaca6132f --- /dev/null +++ b/CONTRIBUTE @@ -0,0 +1,55 @@ +===================== +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. diff --git a/INSTALL b/INSTALL index 9190b19a9f3c454f477cb479ffdec1e5890dd051..4d3fa364874a524d2db7f5bf929a29105aee6e57 100644 --- a/INSTALL +++ b/INSTALL @@ -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. diff --git a/README b/README index cf7c00d1fa79ee10c376a20bd97a4d6cba49c82f..5e6f2df0b2168ca35e6b4c948acb6de662aec32d 100644 --- a/README +++ b/README @@ -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. diff --git a/doc/source/pre/acknowledgements.rst b/doc/source/pre/acknowledgements.rst deleted file mode 100644 index 0a50677aa6eb1e60cae1135afec68132fc3cc521..0000000000000000000000000000000000000000 --- a/doc/source/pre/acknowledgements.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../../ACKNOWLEDGEMENTS diff --git a/doc/source/pre/citing.rst b/doc/source/pre/citing.rst new file mode 100644 index 0000000000000000000000000000000000000000..257c39ef17719d5dea24e7c374dabd51ecb426e3 --- /dev/null +++ b/doc/source/pre/citing.rst @@ -0,0 +1 @@ +.. include:: ../../../CITING diff --git a/doc/source/pre/contribute.rst b/doc/source/pre/contribute.rst new file mode 100644 index 0000000000000000000000000000000000000000..3aa17bcbb3d5666cf601a02a753452afc6176cad --- /dev/null +++ b/doc/source/pre/contribute.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTE diff --git a/doc/source/pre/index.rst b/doc/source/pre/index.rst index 6b0ef8cb990c66158b3441bc4ffa9221658a18f5..91f0ca555207150d26b79957fede35500722cb39 100644 --- a/doc/source/pre/index.rst +++ b/doc/source/pre/index.rst @@ -8,5 +8,6 @@ Preliminaries whatsnew/index install authors - acknowledgements + citing license + contribute