Update citation info to SciPost article

Closes #61
qucontrol · Dec 14, 2019 · 74d4660 · 74d4660
1 parent 15563f4
commit 74d4660
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 18 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -5,6 +5,7 @@ History
 (next version)
 --------------
 
+* Update: Citation info now points to `SciPost paper <https://scipost.org/SciPostPhys.7.6.080>`_ (`#61`_)
 * Added: parameters `col_formats` and `col_headers` to customize the output of ``krotov.info_hooks.print_table`` (`#65`_)
 * Added: info-hooks now have access to the additional arguments `propagator`, `chi_constructor`, `mu`, `sigma`, `iter_start`, and `iter_stop` (`#66`_)
 
@@ -103,5 +104,6 @@ History
 .. _#58: https://github.com/qucontrol/krotov/issues/58
 .. _#59: https://github.com/qucontrol/krotov/issues/59
 .. _#60: https://github.com/qucontrol/krotov/issues/60
+.. _#61: https://github.com/qucontrol/krotov/issues/61
 .. _#65: https://github.com/qucontrol/krotov/issues/65
 .. _#66: https://github.com/qucontrol/krotov/issues/66
diff --git a/README.rst b/README.rst
@@ -28,9 +28,9 @@ Krotov Python Package
 .. image:: https://mybinder.org/badge_logo.svg
    :alt: Launch Binder
    :target: https://mybinder.org/v2/gh/qucontrol/krotov/v0.5.0?filepath=docs%2Fnotebooks
-.. image:: https://img.shields.io/badge/arXiv-1902.11284-red.svg
-   :alt: arXiv
-   :target: https://arxiv.org/abs/1902.11284
+.. image:: https://img.shields.io/badge/DOI-10.21468/SciPostPhys.7.6.080-blue.svg
+   :alt: DOI
+   :target: https://doi.org/10.21468/SciPostPhys.7.6.080
 
 Python implementation of Krotov's method for quantum optimal control.
 

diff --git a/docs/01_overview.rst b/docs/01_overview.rst
@@ -12,23 +12,26 @@ Citing the Krotov Package
 
    Please cite the :mod:`krotov` package as
 
-   * \M. H. Goerz *et al*., *Krotov: A Python implementation of Krotov's method for quantum optimal control*, `arXiv:1902.11284 <https://arxiv.org/abs/1902.11284>`_ (2019)
+   * \M. H. Goerz *et al*., *Krotov: A Python implementation of Krotov's method for quantum optimal control*, `SciPost Phys. 7, 080 <https://scipost.org/SciPostPhys.7.6.080>`_ (2019)
 
 You can also print this from ``krotov.__citation__``:
 
 .. doctest::
 
    >>> print(krotov.__citation__)
-   M. H. Goerz et al., Krotov: A Python implementation of Krotov's method for quantum optimal control, arXiv:1902.11284 (2019)
+   M. H. Goerz et al., Krotov: A Python implementation of Krotov's method for quantum optimal control, SciPost Phys. 7, 080 (2019)
 
 The corresponding BibTeX entry is available in ``krotov.__bibtex__``:
 
 .. doctest::
 
    >>> print(krotov.__bibtex__)
-   @article{arxiv1902.11284,
+   @article{GoerzSPP2019,
        author = {Michael H. Goerz and Daniel Basilewitsch and Fernando Gago-Encinas and Matthias G. Krauss and Karl P. Horn and Daniel M. Reich and Christiane P. Koch},
        title = {Krotov: A {Python} implementation of {Krotov's} method for quantum optimal control},
-       year = {2019},
-       journal = {arXiv:1902.11284},
+       journal={SciPost Phys.},
+       volume={7},
+       pages={80},
+       year={2019},
+       doi={10.21468/SciPostPhys.7.6.080},
    }
diff --git a/docs/_README.patch b/docs/_README.patch
@@ -1,5 +1,5 @@
---- README.rst	2019-12-04 16:41:06.000000000 -0500
-+++ _README.rst	2019-12-04 16:40:58.000000000 -0500
+--- README.rst	2019-12-13 21:54:14.000000000 -0500
++++ _README.rst	2019-12-13 21:54:08.000000000 -0500
 @@ -36,14 +36,14 @@
 
  This implementation follows the original implementation in the `QDYN Fortran library`_.

diff --git a/docs/index.rst b/docs/index.rst
@@ -28,9 +28,9 @@ Welcome to the Krotov package's documentation!
 .. image:: https://mybinder.org/badge_logo.svg
    :alt: Launch Binder
    :target: https://mybinder.org/v2/gh/qucontrol/krotov/v0.5.0?filepath=docs%2Fnotebooks
-.. image:: https://img.shields.io/badge/arXiv-1902.11284-red.svg
-   :alt: arXiv
-   :target: https://arxiv.org/abs/1902.11284
+.. image:: https://img.shields.io/badge/DOI-10.21468/SciPostPhys.7.6.080-blue.svg
+   :alt: DOI
+   :target: https://doi.org/10.21468/SciPostPhys.7.6.080
 
 
 .. toctree::

diff --git a/src/krotov/__init__.py b/src/krotov/__init__.py
@@ -18,16 +18,21 @@
 __arxiv__ = '1902.11284'
 
 __citation__ = (
-    "M. H. Goerz et al., Krotov: A Python implementation of Krotov's method for quantum optimal control, arXiv:%s (2019)"
-    % __arxiv__
+    "M. H. Goerz et al., "
+    "Krotov: A Python implementation of Krotov's method for quantum optimal "
+    "control, "
+    "SciPost Phys. 7, 080 (2019)"
 )
 
 __bibtex__ = r'''
-@article{arxiv1902.11284,
+@article{GoerzSPP2019,
     author = {Michael H. Goerz and Daniel Basilewitsch and Fernando Gago-Encinas and Matthias G. Krauss and Karl P. Horn and Daniel M. Reich and Christiane P. Koch},
     title = {Krotov: A {Python} implementation of {Krotov's} method for quantum optimal control},
-    year = {2019},
-    journal = {arXiv:1902.11284},
+    journal={SciPost Phys.},
+    volume={7},
+    pages={80},
+    year={2019},
+    doi={10.21468/SciPostPhys.7.6.080},
 }
 '''.strip()