Skip to content

Commit

Permalink
Release 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Jun 3, 2024
1 parent e9754de commit eda16ae
Show file tree
Hide file tree
Showing 17 changed files with 1,109 additions and 997 deletions.
6 changes: 3 additions & 3 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ History
=======


1.3.0-dev (unreleased)
----------------------
1.3.0 (2024-06-03)
------------------

* Bugfix: `∫gₐdt` and total functional were reported incorrectly (`#96`_, thanks to `@daviehh`_)
* Bugfix: Restrict `qutip` to version 4. Support for `qutip 5.0` will be added in a later release
* Bugfix: Restrict ``qutip`` to version 4. Support for ``qutip 5.0`` will be added in a later release
* Changed: Dropped support for Python 3.5 and Python 3.6
* Changed: The documentation will no longer be provided in PDF format
* Changed: Development is now organized around hatch_ instead of tox_
Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ listenvs: ## Show all hatch environments
hatch env show

shell: ## Open a shell with all development tools
hatch shell
hatch -e default shell

upload: dist ## Package and upload a release to pypi.org
hatch publish
Expand Down Expand Up @@ -95,15 +95,15 @@ uninstall: ## uninstall the package from the active Python's site-packages
# How to execute notebook files
%.ipynb.log: %.ipynb
@echo ""
hatch run -- jupyter nbconvert --to notebook --execute --inplace --allow-errors --ExecutePreprocessor.kernel_name='python3' --ExecutePreprocessor.timeout=-1 --config=/dev/null $< 2>&1 | tee $@
hatch -e default run -- jupyter nbconvert --to notebook --execute --inplace --allow-errors --ExecutePreprocessor.kernel_name='python3' --ExecutePreprocessor.timeout=-1 --config=/dev/null $< 2>&1 | tee $@

NOTEBOOKFILES = $(shell find docs/notebooks -maxdepth 1 -iname '*.ipynb')
NOTEBOOKLOGS = $(patsubst %.ipynb,%.ipynb.log,$(NOTEBOOKFILES))

notebooks: $(NOTEBOOKLOGS) ## re-evaluate the notebooks
@echo ""
@echo "All notebook are now up to date; the were executed using the python3 kernel"
hatch run -- jupyter kernelspec list | grep python3
hatch -e default run -- jupyter kernelspec list | grep python3

jupyter-lab: ## Run a Jupyterlab server for editing the examples
hatch run -- jupyter lab
hatch -e default run -- jupyter lab
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![Tests](https://github.com/qucontrol/krotov/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/qucontrol/krotov/actions?query=workflow%3ATests)
[![Codecov](https://codecov.io/gh/qucontrol/krotov/branch/master/graph/badge.svg)](https://codecov.io/gh/qucontrol/krotov)
[![BSD License](https://img.shields.io/badge/License-BSD-green.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.1?filepath=docs%2Fnotebooks)
[![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/qucontrol/krotov/v1.3.0?filepath=docs%2Fnotebooks)
[![DOI](https://img.shields.io/badge/DOI-10.21468/SciPostPhys.7.6.080-blue.svg)](https://doi.org/10.21468/SciPostPhys.7.6.080)

Python implementation of Krotov's method for quantum optimal control.
Expand All @@ -22,7 +22,7 @@ You can read the full documentation
[online](https://qucontrol.github.io/krotov).

If you use the `krotov` package in your research, please [cite
it](https://qucontrol.github.io/krotov/v1.2.1/01_overview.html#citing-the-krotov-package).
it](https://qucontrol.github.io/krotov/v1.3.0/01_overview.html#citing-the-krotov-package).

## Purpose

Expand Down
2 changes: 1 addition & 1 deletion binder/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ dependencies:
- matplotlib
- pip:
- watermark
- git+https://github.com/qucontrol/krotov.git@master#egg=krotov
- krotov==1.3.0
2 changes: 1 addition & 1 deletion docs/01_overview.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.2.1?filepath=docs%2Fnotebooks
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.3.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
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.3.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.3.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
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,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.2.1?filepath=docs%2Fnotebooks
:target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.3.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 eda16ae

Please sign in to comment.