Skip to content

Latest commit

 

History

History
273 lines (148 loc) · 6.74 KB

CHANGELOG.md

File metadata and controls

273 lines (148 loc) · 6.74 KB
Raw

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.14.0] - 2024-09-04

Added

  • Support for Python versions 3.11, 3.12
  • GitHub Action CI pipeline tests for Windows, MacOS

Changed

  • Migrated from using Poetry to PDM to support overriding/ignoring subdependencies and switching based on Python version (e.g. cadCAD, which has removed support for Python 3.8, but which we'd like to continue supporting)
  • Implemented tests and benchmarking across Python versions using Nox (equivalent of Tox that uses Python instead of yaml for configuration)
  • Updated cadCAD dependency to v0.5.3 to ensure compatibility with Python 3.10+ when using "compatibility mode"
  • Added RADCAD_BACKEND environment variable to override radCAD's backend, specifically used for Windows tests to avoid recursion depth errors

[0.13.0] - 2023-10-26

Added

  • Ability to override the method used for performing deep copies, e.g. using Pickle instead of standard library for better performance
  • Ability to use dataclasses instead of dictionaries to configure System Parameters, enabling much better developer experience including typing of System Parameters
  • Ability to use nested dataclasses to configure System Parameters to enable creating categories or namespaces of System Parameters for better management of large models, see tests for examples of how this works
  • Better typing of all core radCAD code, see radcad.types

Changed

  • End of support for Python 3.7, due to dependecies we now only support >= 3.8
  • Major refactor of core code to use specification for simulation execution in the form of an abstract base class named SimulationExecutionSpecification, enabling much better understanding, customisation, and extension of radCAD core code

[0.12.0] - 2022-09-05

Added

  • Add typing

Changed

  • Enable mutation of simulation hook Context
  • Possibly breaking change for anyone using hooks: before_simulation(simulation: Simulation) changed to before_simulation(context: Context)

[0.11.1] - 2022-09-03

Added

  • Add support for parameters dataclass
  • Add support for single value parameters (i.e. not a list)

[0.11.0] - 2022-09-03

Changed

  • Adapted core deepcopy processes to be more efficient and avoid unintended mutation of state between policy and state update functions

[0.10.1] - 2022-09-02

Changed

  • Updated to use "radCAD" logging instance

[0.10.0] - 2022-09-01

Added

  • Add a deepcopy_method Engine argument to allow setting a custom deepcopy method e.g. copy.deepcopy instead of default Pickle methods

Changed

  • Fix edge case of unintended mutation of state passed to state update function from policy function (see issue #53)

[0.9.1] - 2022-07-26

Added

  • Thanks to @vmeylan for a developer experience contribution in radcad/core.py: make _update_state() error messages more verbose for easier debugging

[0.9.0] - 2022-06-14

Changed

  • Context passed to before_subset(context) hook will now correctly receive a single parameter subset and not all subsets
  • This could be a breaking change for anyone that relied on the before_subset() hook - the before_run() hook will still receive all subsets, as at that point of simulation the specific subset is unknown
  • See "NOTE" in engine.py: Each parameter is a list of all subsets in before_run() method and a single subset in before_subset()

[0.8.4] - 2021-09-04

Added

  • Overide for __deepcopy__ method of Executable class to enable deepcopy after a simulation/experiment has been run
  • Add regression test for above __deepcopy__ method

[0.8.3] - 2021-08-30

Changed

  • Update radCAD package version in init.py

[0.8.2] - 2021-08-27

Changed

  • Update cadCAD from v0.4.23 to v0.4.27, fixing breaking changes to compat module

[0.8.1] - 2021-08-24

Changed

  • Minor update: Module package version & package details

[0.8.0] - 2021-06-28

Changed

  • engine.deepcopy setting now disables deepcopy of State as well as Policy Signals

[0.7.1] - 2021-06-11

Added

[0.7.0] - 2021-06-09

Changed

  • Experiment and Simulation extend the Executable class (not a breaking change, but significant improvement to API)

[0.6.7] - 2021-06-08

Added

  • generate_cartesian_product_parameter_sweep(...) method to radcad.utils

[0.6.6] - 2021-06-08

Added

  • Base wrapper class

[0.6.5] - 2021-06-03

Added

  • Iterable Models

[0.6.4] - 2021-05-31

Added

  • Support for Python 3.9 (<4.0)

[0.6.3] - 2021-04-30

Added

  • Update dependencies

[0.6.2] - 2021-04-30

Added

  • Removed Streamlit which requires Python <3.9

[0.6.1] - 2021-04-30

Added

  • Support for Python 3.9

Changed

  • Added tests for hook functionality, fixed minor error, removed WIP tag
  • Updated log statement for "Starting simulation ..."

[0.6.0] - 2021-02-20

Changed

  • Moved Ray and dependencies to optional extension extension-backend-ray
  • Refactored Backend module
  • Introduced idea of extensions

[0.5.6] - 2021-02-10

Added

  • drop_substeps (default False) option to Engine

[0.5.5] - 2021-02-08

Changed

  • Incorrect argument given to Pathos pool for number of processes
  • Update memory benchmarks to not test A/B testing
  • Change Python max version from <3.9 to <=3.9
  • Update hook API and add subset hook

[0.5.4] - 2021-02-08

Added

  • Error tracebacks to exceptions data

[0.5.3] - 2021-02-07

Changed

  • Close Pathos, Multiprocessing pools

[0.5.2] - 2021-02-06

Changed

  • Pandas version ^1.0.0

[0.5.1] - 2021-02-06

Added

  • Add hook example for saving experiment results to HDF5 file format

[0.5.0] - 2021-02-05

Added

  • Predator-prey benchmark test

Changed

  • Refactor core from Rust to Python

[0.4.1] - 2021-02-02

Added

  • Add engine deepcopy option, to disable deepcopy of state

Changed

  • Significant performance tuning of Rust core for 2x increase in speed and reduction in memory use

[0.4.0] - 2021-02-01

Changed

  • Fix of critical state update bug, added regression test test_paralell_state_update() to test_regression.py

[0.3.1] - 2021-01-31

Changed

  • Python version downgrade to ^3.7 for Streamlit

[0.3.0] - 2021-01-30

Added

  • Error handling (default Engine(raise_exceptions=True))
  • Partial simulation results (on run failure / exception)
  • Memory profiling using mprof

Changed

  • Default simulation engine (changed from MULTIPROCESSING to PATHOS)

Removed