Browse code
prepare a more detailed test suit, fix minor typos
Summary of changes:
* Add a test for trailing whitespace, remove all trailling whitespace
* Add a test for broken URLs in docs, fix all broken URLs and permanent redirects
* Switch sphinx doc build to strict (warnings to errors) and nitpicky (broken links to warnings). Fix all sphinx warnings.
* Deploy docs from any commit to [kwant/kwant](https://gitlab.kwant-project.org/kwant/kwant) to https://test.kwant-project.org/doc/dev
* Deploy docs from any commit to master at kwant/kwant to https://kwant-project.org/doc/dev
* Deploy docs from any tag release tag (so anything that is vX.Y.Z) at kwant/kwant to https://kwant-project.org/doc/X.Y
Anton Akhmerov authored on 05/08/2016 22:57:01
Showing 1 changed files
| ... | ... |
@@ -15,7 +15,7 @@ cite the main paper that introduces Kwant: |
| 15 | 15 |
C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal, |
| 16 | 16 |
*Kwant: a software package for quantum transport*, |
| 17 | 17 |
`New J. Phys. 16, 063065 (2014) |
| 18 |
- <http://iopscience.iop.org/1367-2630/16/6/063065/article>`_. |
|
| 18 |
+ <https://iopscience.iop.org/1367-2630/16/6/063065/article>`_. |
|
| 19 | 19 |
|
| 20 | 20 |
|
| 21 | 21 |
Other references we ask you to consider |
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
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,38 @@ |
| 1 |
+============ |
|
| 2 |
+Citing Kwant |
|
| 3 |
+============ |
|
| 4 |
+ |
|
| 5 |
+We provide Kwant as free software under a :doc:`BSD license <license>` as a |
|
| 6 |
+service to the physics community. If you have used Kwant for work that has |
|
| 7 |
+lead to a scientific publication, please mention the fact that you used it |
|
| 8 |
+explicitly in the text body. For example, you may add |
|
| 9 |
+ |
|
| 10 |
+ *the numerical calculations were performed using the Kwant code* |
|
| 11 |
+ |
|
| 12 |
+to the description of your numerical calculations. In addition, we ask you to |
|
| 13 |
+cite the main paper that introduces Kwant: |
|
| 14 |
+ |
|
| 15 |
+ C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal, |
|
| 16 |
+ *Kwant: a software package for quantum transport*, |
|
| 17 |
+ `New J. Phys. 16, 063065 (2014) |
|
| 18 |
+ <http://iopscience.iop.org/1367-2630/16/6/063065/article>`_. |
|
| 19 |
+ |
|
| 20 |
+ |
|
| 21 |
+Other references we ask you to consider |
|
| 22 |
+--------------------------------------- |
|
| 23 |
+ |
|
| 24 |
+If you have profited from the quantum transport functionality of Kwant, please |
|
| 25 |
+also cite the upcoming paper that describes the relevant algorithms. The |
|
| 26 |
+reference will also be added here once it is available. |
|
| 27 |
+ |
|
| 28 |
+Kwant owes much of its current performance to the use of the `MUMPS |
|
| 29 |
+<http://graal.ens-lyon.fr/MUMPS/>`_ library for solving systems of sparse linear |
|
| 30 |
+equations. If you have done high-performance calculations, we suggest citing |
|
| 31 |
+ |
|
| 32 |
+ P. R. Amestoy, I. S. Duff, J. S. Koster, J. Y. L’Excellent, SIAM. J. Matrix |
|
| 33 |
+ Anal. & Appl. 23 (1), 15 (2001). |
|
| 34 |
+ |
|
| 35 |
+Finally, if you use the routine for generation of circular ensembles of random |
|
| 36 |
+matrices, please cite |
|
| 37 |
+ |
|
| 38 |
+ \F. Mezzadri, Notices Am. Math. Soc. 54, 592 (2007). |