Changelog

All notable changes will be listed in this file. This project adheres to Semantic Versioning.

If you want to see a change please contact us.

Unreleased / planned

Pay special attention to anything with a [DEPRECATION] next to it as this is something that will be deprecated and removed in future versions.

0.2.14

Fixed

  • Fixed issue with docs not building due to sphinx-rtd-theme version and OrcFxApi Linux stub.

0.2.13

Fixed

  • Fixed issue with docs not building due to sphinx version.

0.2.12

Fixed

  • Fixed issue with pyqt5 platform-specific/architecture-specific versioning.

0.2.11

Changed

  • Changed deploy script and bumped pyqalx version.

0.2.10

Changed

  • Changed pyqalx version and updated docs.

0.2.9

Fixed

  • Fixed onload bug.

0.2.8

Added

  • Added delete_message_on_load job option.

0.2.7

Changed

  • Update docs to include as_file argument for RangeGraph and TimeHistory models.

0.2.6

Added

  • Added ability to save RangeGraph and TimeHistory results as file items.

0.2.5

Added

  • Increased test coverage for SimulationBot step functions.

0.2.4

Fixed

  • Fixed bug in SimulationBot postprocess function.

0.2.3

Changed

  • Update to pyqalx==0.18.6, which includes important factory workflow fixes.

0.2.2

Fixed

  • Fix bug where the Waiter was exiting before the batch was complete. This happened when the sets were processed but the results summarisation was not complete.

0.2.1

Fixed

  • BatchBot - now waits for the SimBot to finish processing all sets before marking the batch as complete.

0.2.0

Added

  • Restarts - models that use the OrcaFlex 11.2 restarts feature are now supported within batches; see Building Batches for further details.

Changed

  • the minimum Python version is now 3.8.

  • the minimum pyqalx version is now 0.18.5, which contains a number of bug fixes and improvements.

Removed

Fixed

  • the Batch GUI no longer errors when displaying a batch with no complete sims.

0.1.8

Added

  • Notifications - you can now specify emails to be sent on batches being submitted, completed or after some specified time-out period if not complete. The examples and tests have been updated to use this.

  • Batch GUI - there is now a GUI available to show the progress of a batch to the user. It will also allow you to show this as part of a “waiter” and then move on some code when the processing is complete.

Changed

  • the web address for qalx has changed from a .io domain to .net (this is partly due to an on-going controversy over the colonial history of the British Indian Ocean Territory).

Removed

Fixed

  • when adding sets to a batch there was a bug where a call to add_many which resulted in errors would lead to the sets being created with incorrect items assigned to the set keys. This has been fixed so that errors raise and exception.

  • the Batch Bot performance has been improved to ensure there are not as many requests required to unpack the sets.

  • fixed a soft memory leak in SimBot where the updates on job progress where farmed off to another thread.

0.1.7

Added

Changed

  • state of a job is now tracked using a JobState enum and the transition of states is more refined and obvious. A section has been added to Building Batches to describe the various states.

  • the minimum pyqalx version is now 0.14.1 which contains a number of bug fixes and improvements.

Removed

Fixed

  • the SimBot would disable in-memory logging if the simulation was expected to be larger than the available memory. However, it was doing this based on the total memory rather than the available memory.

0.1.6

Added

  • Model video extraction: You can now specify model view parameters and a video specification to get automatic AVI extraction for a simulation. There is also a stand-alone bot that can do these extractions for an existing simulation.

  • Smart Statics now allows users to specify results that get checked before a model is considered “solved”. This is to combat the issue where the model solves in statics but the solution is not a realistic physical condition, e.g. a line may have a “loop”

Changed

  • Smart statics now records all attempts in the Model().general.Comments field and if no solution can be found the data file is saved to the job in job.items.failed_statics

Removed

Fixed

  • Building batches using ModelSource in previous versions would keep the bytes for every model in memory while the batch was building. This would use too much RAM when building large batches. The data is now stored on disk in a temporary directory which is deleted automatically once the batch has built or if there is an error.