From 8d69dd366b5fe33cd466d73e1d6b19a86dc6cde4 Mon Sep 17 00:00:00 2001 From: Patrick <> Date: Wed, 1 May 2024 11:43:36 +0200 Subject: [PATCH] changelog --- doc/changelog.rst | 19 ++++++++++++++++--- doc/guide/guide-control.rst | 3 ++- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index fa27ba4..ac34659 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -3,16 +3,29 @@ Changelog ********* -Version 0.1.0 (April xx, 2024) +Version 0.1.0 (May xx, 2024) +++++++++++++++++++++++++++++++++ -TODO: Add release notes +This is the beta release of qutip-qoc, the extended quantum control package in QuTiP. + +It has undergone major refactoring and restructuring of the codebase. + +- Non-public facing functions have been renamed to start with an underscore. +- As with other QuTiP functions, `optimize_pulses` now takes a `tlist` argument instead of `TimeInterval`. +- The structure for the control guess and bounds has changed and now takes in an optional `__time__` keyword. +- The `result` does no longer return `optimized_objectives` but instead `optimized_H`. + +Bug Fixes +--------- + +- basinhopping result does not contain minimizer message +- boundary issues with CRAB Version 0.0.0 (December 26, 2023) +++++++++++++++++++++++++++++++++ -This is the first release of qutip-qoc, the extended quantum control package in QuTiP. +This is the alpha release of qutip-qoc, the extended quantum control package in QuTiP. The qutip-qoc package builds up on the ``qutip-qtrl`` `package `_. It enhances it by providing two additional algorithms to optimize analytically defined control functions. diff --git a/doc/guide/guide-control.rst b/doc/guide/guide-control.rst index ff24c5e..05bb0af 100644 --- a/doc/guide/guide-control.rst +++ b/doc/guide/guide-control.rst @@ -272,4 +272,5 @@ Eventually, the optimization for a desired `fid_err_targ` can be started by call }, ) -Examples for Liouvillian dynamics and multi-objective optimization can be found in the examples folder. +.. TODO: add examples +Examples for Liouvillian dynamics and multi-objective optimization will follow soon.