Changelog

All notable changes to the sim-explorer project will be documented in this file.
The changelog format is based on Keep a Changelog.

Unreleased

-/-

0.2.1 - 2025-02-05

Added

  • Added CITATION.cff file

  • Added mypy and pyright as static type checkers

Changed

  • Simplified set/get_variable_value interface, so that the special OSP set_initial call is not in general needed.

  • Renamed SimulatorInterface to SystemInterface

  • Modularized SystemInterface, and abstracted it away from the specific simulator:
    SystemInterface managing only the specifications, SystemInterfaceOSP also being able to run simulations.

  • Updated code base to be in sync with latest changes in python_project_template

  • tests/test_oscillator_fmu.py : Skip test test_run_osp_system_structure() on Linux. The HarmonicOscillator.fmu throws an error on Linux (not though on Windows).

Solved

  • Updated make_osp_system_structure() to correctly handle bool

  • Added missing type hints

  • Resolved issues raised by ruff, mypy and pyright

  • Sphinx documentation: resolved warnings raised in build process

Dependencies

  • Updated to ruff>=0.9.2 (from ruff>=0.6.3)

  • Updated to pyright>=1.1.392 (from pyright>=1.1.378)

  • Updated to sourcery>=1.31 (from sourcery>=1.22)

  • Updated to numpy>=1.26 (from numpy>=1.26,<2.0)

  • Updated to matplotlib>=3.10 (from matplotlib>=3.9.1)

  • Updated to pytest-cov>=6.0 (from pytest-cov>=5.0)

  • Updated to Sphinx>=8.1 (from Sphinx>=8.0)

  • Updated to sphinx-argparse-cli>=1.19 (from sphinx-argparse-cli>=1.17)

  • Updated to sphinx-autodoc-typehints>=3.0 (from sphinx-autodoc-typehints>=2.2)

  • Updated to pre-commit>=4.0 (from pre-commit>=3.8)

  • Updated to mypy>=1.14 (from mypy>=1.11.1)

  • Updated to setup-uv@v5 (from setup-uv@v2)

0.2.0 - 2024-12-18

New Assertions release:

  • Added support for assertions in each of the cases to have some kind of evaluation being run after every simulation.

  • Display features to show the results of the assertions in a developer friendly format.

0.1.0 - 2024-11-08

Changed

  • Changed from pip/tox to uv as package manager

  • README.rst : Completely rewrote section “Development Setup”, introducing uv as package manager.

  • Changed publishing workflow to use OpenID Connect (Trusted Publisher Management) when publishing to PyPI

GitHub workflows

  • (all workflows): Adapted to use uv as package manager

  • _test_future.yml : updated Python version to 3.13.0-alpha - 3.13.0

  • _test_future.yml : updated name of test job to ‘test313’

Dependencies

  • updated to component-model>=0.1.0 (from component-model>=0.0.1)

0.0.1 - 2023-02-21

  • Initial release

Added

  • added this

Changed

  • changed that

Dependencies

  • updated to some_package_on_pypi>=0.1.0

Fixed

  • fixed issue #12345

Deprecated

  • following features will soon be removed and have been marked as deprecated:

    • function x in module z

Removed

  • following features have been removed:

    • function y in module z