Merge pull request #325 from dmgav/rel-v0.0.22

Release Notes: v0.0.22

Author: dmgav

bluesky_queueserver/profile_collection_sim/existing_plans_and_devices.yaml

@@ -1575,7 +1575,7 @@ existing_plans:
       name: min_step
     - annotation:
         type: float
-      description: largest step for slow-chaning regions
+      description: largest step for slow-changing regions
       kind:
         name: POSITIONAL_OR_KEYWORD
         value: 1
@@ -2322,14 +2322,14 @@ existing_plans:
       name: motor
     - annotation:
         type: float
-      description: starting position of motor
+      description: starting position of motor, relative to the current position.
       kind:
         name: POSITIONAL_OR_KEYWORD
         value: 1
       name: start
     - annotation:
         type: float
-      description: ending position of motor
+      description: ending position of motor, relative to the current position.
       kind:
         name: POSITIONAL_OR_KEYWORD
         value: 1
@@ -2343,7 +2343,7 @@ existing_plans:
       name: min_step
     - annotation:
         type: float
-      description: largest step for slow-chaning regions
+      description: largest step for slow-changing regions
       kind:
         name: POSITIONAL_OR_KEYWORD
         value: 1

docs/source/release_history.rst

@@ -2,6 +2,62 @@
 Release History
 ===============
 
+v0.0.22 (2025-05-18)
+====================
+
+Added
+-----
+
+- Support for ``bluesky.protocols.NamedMovable`` protocol.
+
+- Support for the new CLI parameters: ``--ipython-connection-dir``, ``--ipython-connection-file``,
+  ``--ipython-shell-port``, ``--ipython-iopub-port``, ``--ipython-stdin-port``, ``--ipython-hb-port``,
+  ``--ipython-control-port``.
+
+- Support for the new environment variables:   ``QSERVER_IPYTHON_KERNEL_CONNECTION_FILE``,
+  ``QSERVER_IPYTHON_KERNEL_CONNECTION_DIR``, ``QSERVER_IPYTHON_KERNEL_IOPUB_PORT``,
+  ``QSERVER_IPYTHON_KERNEL_HB_PORT``, ``QSERVER_IPYTHON_KERNEL_CONTROL_PORT``,
+  ``QSERVER_IPYTHON_KERNEL_SHELL_PORT``, ``QSERVER_IPYTHON_KERNEL_STDIN_PORT``.
+
+- Support for the new parameters in the ``worker`` section of RE Manager config file:
+  ``ipython_connection_file``, ``ipython_connection_dir``, ``ipython_shell_port``, ``ipython_iopub_port``,
+  ``ipython_stdin_port``, ``ipython_hb_port``, ``ipython_control_port``.
+
+- New parameter for setting 0MQ message encoding added to RE Manager and the clients:
+  ``--zmq-encoding`` CLI parameter, ``QSERVER_ZMQ_ENCODING_FOR_SERVER`` environment variable and
+  ``network/zmq_encoding`` config file parameter.
+
+Fixed
+-----
+
+- Fixed an issue with handling of ``collections.abc.Iterable`` plan parameter type.
+
+Changed
+-------
+
+- The built-in feature that allowed instantiation and configuring Run Engine was removed.
+  Now Run Engine must be instantiated and configured in the startup code.
+
+- The following CLI parameters were removed: ``--kafka-topic``, ``--kafka-server``,
+  ``--zmq-data-proxy-addr``, ``--use-persistent-metadata`` and ``--databroker-config``.
+
+- RE Manager accepts ``--keep-re`` CLI parameter. The value of the parameter is ignored.
+  RE Manager always work as if the option is enabled. Deprecation message is printed.
+
+- The ``run-engine`` section is removed from the config file (``use_persistent_metadata``,
+  ``kafka_server``, ``kafka_topic``, ``zmq_data_proxy_addr``, ``databroker_config``). The server
+  accept ``startup/keep_re`` parameter. The parameter value is ignored, deprecation message is printed.
+
+- The following packages are removed from dependencies: ``bluesky-kafka``, ``databroker``,
+  ``event_model``, ``msgpack``, ``msgpack_numpy``.
+
+- Now RE Manager can successfully load startup code, which does not create an instance of Run Engine
+  (``environment_open`` operation would fail in the past). In this case, RE Manager returns status
+  parameter ``re_state: None`` and attempts to start the queue or individual plan fail with appropriate
+  error messages. Clients are still able to execute scripts or functions in the environment. Run Engine
+  may be instantiated and configured (e.g. by uploading a script) before any plans are executed.
+
+
 v0.0.21 (2024-09-29)
 ====================