Skip to content

Commit

Permalink
Release 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Aug 17, 2020
1 parent e2da7fb commit b9b9a2d
Show file tree
Hide file tree
Showing 17 changed files with 210 additions and 196 deletions.
12 changes: 7 additions & 5 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Development Team
----------------

* Daniel Basilewitsch <[email protected]>
* Fernando Gago Encinas <fernando.gago@physik.uni-kassel.de>
* Fernando Gago Encinas <fernando.gago@fu-berlin.de>
* Matthias Krauss <[email protected]>
* Karl Horn <[email protected]>
* `Daniel Reich`_ <[email protected].de>
* `Christiane Koch`_ <christiane.koch@uni-kassel.de>
* `Daniel Reich`_ <[email protected].de>
* `Christiane Koch`_ <christiane.koch@fu-berlin.de>

.. _Michael Goerz: https://michaelgoerz.net
.. _Daniel Reich: https://www.uni-kassel.de/fb10/en/institutes/physics/research-groups/quantum-dynamics-and-control/group-members/dr-daniel-reich.html
Expand All @@ -29,10 +29,12 @@ Acknowledgements
We thank
`@TejasAvinasShetty`_,
`@nathanshammah`_,
`@timohillmann`_, and
`@uiofgh`_,
`@timohillmann`_,
`@uiofgh`_, and
`@zachmanson`_,
for reporting bugs and suggesting improvements.

.. _@zachmanson: https://github.com/zachmanson
.. _@TejasAvinasShetty: https://github.com/TejasAvinashShetty
.. _@nathanshammah: https://github.com/nathanshammah
.. _@timohillmann: https://github.com/timohillmann
Expand Down
12 changes: 12 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
History
=======

1.2.0 (2020-08-17)
------------------

* Added: ``via_midpoints`` argument to ``krotov.converersions.discretize`` function
* Changed: Controls and update shapes are now discretized in a way that ensures numerical stability (`#74`_, thanks to `@zachmanson`_)
* Changed: Replaced ``uniseg`` dependency with ``grapheme`` (`#76`_)

Note: due to the changes in the time discretization of the controls and update shapes, this version will generally not reproduce optimization results from previous versions to machine precision.


1.1.0 (2020-03-24)
------------------
Expand Down Expand Up @@ -108,6 +117,7 @@ History
.. _@TejasAvinashShetty: https://github.com/TejasAvinashShetty
.. _@timohillmann: https://github.com/timohillmann
.. _@nathanshammah: https://github.com/nathanshammah
.. _@zachmanson: https://github.com/zachmanson
.. _#26: https://github.com/qucontrol/krotov/issues/26
.. _#29: https://github.com/qucontrol/krotov/issues/29
.. _#32: https://github.com/qucontrol/krotov/issues/32
Expand All @@ -132,3 +142,5 @@ History
.. _#67: https://github.com/qucontrol/krotov/issues/67
.. _#68: https://github.com/qucontrol/krotov/issues/68
.. _#72: https://github.com/qucontrol/krotov/issues/72
.. _#74: https://github.com/qucontrol/krotov/issues/74
.. _#76: https://github.com/qucontrol/krotov/issues/76
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Krotov Python Package
:target: https://opensource.org/licenses/BSD-3-Clause
.. image:: https://mybinder.org/badge_logo.svg
:alt: Launch Binder
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.1.0?filepath=docs%2Fnotebooks
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.0?filepath=docs%2Fnotebooks
.. 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
Expand All @@ -43,7 +43,7 @@ Development happens on `Github`_. You can read the full documentation `online`__
.. _Documentation: https://qucontrol.github.io/krotov
__ Documentation_

If you use the ``krotov`` package in your research, please `cite it <https://qucontrol.github.io/krotov/v1.1.0/01_overview.html#citing-the-krotov-package>`_.
If you use the ``krotov`` package in your research, please `cite it <https://qucontrol.github.io/krotov/v1.2.0/01_overview.html#citing-the-krotov-package>`_.

.. _QDYN Fortran library: https://www.qdyn-library.net
.. _QuTiP: http://qutip.org
Expand Down Expand Up @@ -172,11 +172,11 @@ Then,
number of control fields over all the objectives.

.. |krotov.Objective| replace:: ``krotov.Objective``
.. _krotov.Objective: https://qucontrol.github.io/krotov/v1.1.0/API/krotov.objectives.html#krotov.objectives.Objective
.. _krotov.Objective: https://qucontrol.github.io/krotov/v1.2.0/API/krotov.objectives.html#krotov.objectives.Objective

.. |krotov.optimize_pulses| replace:: ``krotov.optimize_pulses``
.. _krotov.optimize_pulses: https://qucontrol.github.io/krotov/v1.1.0/API/krotov.optimize.html#krotov.optimize.optimize_pulses
.. _krotov.optimize_pulses: https://qucontrol.github.io/krotov/v1.2.0/API/krotov.optimize.html#krotov.optimize.optimize_pulses

See `Using Krotov with QuTiP <https://qucontrol.github.io/krotov/v1.1.0/08_qutip_usage.html#using-krotov-with-qutip>`_ and `Examples <https://qucontrol.github.io/krotov/v1.1.0/09_examples.html>`_ for details.
See `Using Krotov with QuTiP <https://qucontrol.github.io/krotov/v1.2.0/08_qutip_usage.html#using-krotov-with-qutip>`_ and `Examples <https://qucontrol.github.io/krotov/v1.2.0/09_examples.html>`_ for details.

.. _Jupyter notebook: https://jupyter.org
2 changes: 1 addition & 1 deletion binder/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ dependencies:
- pip:
- matplotlib
- watermark
- git+https://github.com/qucontrol/krotov.git@master#egg=krotov
- krotov==1.2.0
2 changes: 1 addition & 1 deletion docs/09_examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Examples

.. raw:: html

<a href="http://nbviewer.jupyter.org/github/qucontrol/krotov/blob/master/docs/notebooks" target="_blank"><img alt="Render on nbviewer" src="https://img.shields.io/badge/render%20on-nbviewer-orange.svg" style="vertical-align:text-bottom"></a>&nbsp;<a href="https://mybinder.org/v2/gh/qucontrol/krotov/master?filepath=docs%2Fnotebooks" target="_blank"><img alt="Launch Binder" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>
<a href="http://nbviewer.jupyter.org/github/qucontrol/krotov/blob/v1.2.0/docs/notebooks" target="_blank"><img alt="Render on nbviewer" src="https://img.shields.io/badge/render%20on-nbviewer-orange.svg" style="vertical-align:text-bottom"></a>&nbsp;<a href="https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.0?filepath=docs%2Fnotebooks" target="_blank"><img alt="Launch Binder" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>

.. toctree::
:maxdepth: 1
Expand Down
8 changes: 4 additions & 4 deletions docs/_README.patch
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
.. _Documentation: https://qucontrol.github.io/krotov
__ Documentation_

-If you use the ``krotov`` package in your research, please `cite it <https://qucontrol.github.io/krotov/v1.1.0/01_overview.html#citing-the-krotov-package>`_.
-If you use the ``krotov`` package in your research, please `cite it <https://qucontrol.github.io/krotov/v1.2.0/01_overview.html#citing-the-krotov-package>`_.
+If you use the :mod:`krotov` package in your research, please :ref:`cite it <CitingKrotov>`.

.. _QDYN Fortran library: https://www.qdyn-library.net
Expand Down Expand Up @@ -55,12 +55,12 @@
number of control fields over all the objectives.

-.. |krotov.Objective| replace:: ``krotov.Objective``
-.. _krotov.Objective: https://qucontrol.github.io/krotov/v1.1.0/API/krotov.objectives.html#krotov.objectives.Objective
-.. _krotov.Objective: https://qucontrol.github.io/krotov/v1.2.0/API/krotov.objectives.html#krotov.objectives.Objective

-.. |krotov.optimize_pulses| replace:: ``krotov.optimize_pulses``
-.. _krotov.optimize_pulses: https://qucontrol.github.io/krotov/v1.1.0/API/krotov.optimize.html#krotov.optimize.optimize_pulses
-.. _krotov.optimize_pulses: https://qucontrol.github.io/krotov/v1.2.0/API/krotov.optimize.html#krotov.optimize.optimize_pulses
-
-See `Using Krotov with QuTiP <https://qucontrol.github.io/krotov/v1.1.0/08_qutip_usage.html#using-krotov-with-qutip>`_ and `Examples <https://qucontrol.github.io/krotov/v1.1.0/09_examples.html>`_ for details.
-See `Using Krotov with QuTiP <https://qucontrol.github.io/krotov/v1.2.0/08_qutip_usage.html#using-krotov-with-qutip>`_ and `Examples <https://qucontrol.github.io/krotov/v1.2.0/09_examples.html>`_ for details.
+See :ref:`using-krotov-with-qutip` and :ref:`krotov-example-notebooks` for details.

.. _Jupyter notebook: https://jupyter.org
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Welcome to the Krotov package's documentation!
:target: https://opensource.org/licenses/BSD-3-Clause
.. image:: https://mybinder.org/badge_logo.svg
:alt: Launch Binder
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.1.0?filepath=docs%2Fnotebooks
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.0?filepath=docs%2Fnotebooks
.. 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
Expand Down
Loading

0 comments on commit b9b9a2d

Please sign in to comment.