Changelog

1.5.0

  • Allow views to be executed concurrently
  • Record bandwidth used for index and data in event summary
  • Apply prototype formatting fields to label if present
  • Remove local modules from sys.modules rather than directly reloading them on context creation
  • Fix squeezing 1-dim arrays with a single element from Karabo hashes
  • Fix global parameters in prototypes and imported modules
  • Fix missing copy when queuing feedback messages in ThreadedFrontend
  • Change license to MPL-2.0

1.4.4

  • Fix concretizing prototype arguments permanently on view group prototype

1.4.3

  • Add support to automatically dereference calng shared memory handles
  • Add support for RunToPipe overrides
  • Add pX:rY syntax to directly load runs from GPFS in extra-metropc-run
  • Generalize SortedVector view implementation ann add SortedScalar
  • Improve Windows support by using getpass.getuser()
  • Fix BinReduce view results not being averaged when some bins are empty

1.4.2

  • Track stage transfer times and drop events exceeding a limit
  • Support for ticket IDs to track replies to control network messages
  • Support aligned structured dtypes in protocol
  • Add draft for pipeline monitoring CLI
  • Improve code snippets shown in ContextErrors
  • Add ViewError for view-related errors after definition
  • Fix cast from non-native dtypes in MatrixHistogramView
  • Fix broken hot reconfiguration in extra-metropc-run due to typo
  • Fix possible mismatch between vector coordinates and data in SortedVectorView
  • Fix uncaught AssertionError from Karabo when converting ndarrays from fast data
  • Fix typo in accessing ZMQ addresses reported back to frontend from pipeline

1.4.1

  • Raise InvalidHashEntryError when invalid Karabo hash values are encountered
  • Raise ValueError in SortedVectorView when custom coordinates do match vector length
  • Prevent extraction of hash values as view arguments in Bound
  • Fix possible allocation failure when using SortedVectorView in averaging mode

1.4.0

  • Add synchronous frontend implementation using threads
  • Improve stage API for robuster lifecycle management
  • Add support for pipeline-side changes to parameters
  • Add import of parameter state from mpcstate files in extra-metropc-run
  • Add support for profiling and load data in extra-metropc-run
  • Add support for empty targets and simulation mode in extra-metropc-run
  • Add support for operators in extra-metropc-run
  • Fix import of slices via YAML in extra-metropc-run
  • Fix image axis order
  • Fix several quirks and corner cases for binning axes
  • Check for required properties when scanning Karabo motors
  • Add support for Karabo 2.14 in KaraboPath

1.3.2

  • Add support to clear transient and constant data only for selected views
  • Add time-of-flight information and event opcode
  • Add interactive view command to extra-metropc-run
  • Fix importing modules before their own package when reloading
  • Fix loss of closure for view functions

1.3.1

  • Add persistent parameters to extra-metropc-run via YAML
  • Add accumulating_input flag to MovingAverageView
  • Fix xarray label and coords with SortedVectorView
  • Fix various Bound API quirks in KaraboPath key extraction

1.3.0

  • Add HistogramView and SortedVectorView implementations for advanced binning
  • Add support to modularize context code
  • Add support for custom axes, labels and annotations based on xarray
  • Add support for explicit sequencing of events though the pipeline
  • Add support for view labels, docstrings and counters for actual and virtual views
  • Add support for scoped parameters in view groups
  • Add support to run pipeline stages in external python environments
  • Add high performance analysis functions and Karabo operator templates
  • Combine rank and output view properties into one output property
  • Use metropc protocol for output connection

Changes in context code

As a result of the new view output property, the semantics of the Points keyword have changed. It now defines its own output type on the same level as Vector or Matrix and may thus not be used on combination with either of these. The new behaviour is comparable to the previous Image_Points, while Vector_Points may be achieved by using the a view implementation with Vector_Histogrmam.

Karabo paths now use square brackets [ and ] to specify the pipeline key within a hash rather than simply following the pipeline name with dots.

For this version, a special compatibility mode is active that translates these previous uses of Points into their new Histogram replacements and also supports the old Karabo path style. This will be removed in a later version.

Changes in protocol

There are incompatible changes to both the control and the output protocol in this update.

1.2.1

  • Fix different view implementations being ignored for view prototypes
  • Fix setup script to allow non-release version numbers
  • Fix parsing boolean string values in interactive extra-metropc-run
  • Add clearing commands to interactive extra-metropc-run

1.2.0

  • Add path API and re-implement all existing paths on top of it
  • Add support for wildcards in ViewPath and KaraboPath
  • Add support for view prototypes and view groups
  • Add support for hidden views
  • Add interactive mode to extra-metropc-run

1.1.0

  • Add extra-metropc-run to process EuXFEL run data files
  • Add (extra-)metro-validate to parse and validate context code
  • Numpy arrays are serialized more efficiently between pipeline stages and all dtypes are supported
  • Introduce enums for view and context properties, output protocol remains compatible for now
  • Lots of minor clean-ups in pipeline stages

1.0.2

  • Fix AttributeError when executing an action view

1.0.1

  • Fix pipeline crash when decoding object ndarrays
  • Fix forwarding internal context features to other stages
  • Fix missing context API update to tests
  • Add tests for protocol en-/decoding

1.0.0

  • First stable version with the complete initial feature set