Merge pull request #22 from dnv-opensource/eis

Merge eis into main, as prep for release 0.4.0

Author: ClaasRostock

CHANGELOG.md

@@ -8,6 +8,22 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 * -/-
 
 
+## [0.4.0] - 2026-03-12
+
+### Breaking Changes
+* src/component_model/utils/controls.py: Refactored `Controls` from a multi-variable container into per-variable `Control` objects with typed read/write access, and improved goal tracking so initial speed and acceleration are handled correctly when setting or changing goals.
+* src/component_model/utils/analysis.py: Reworked sine fitting by moving the `sine_fit()` function from `component_model.analytic` into `component_model.utils.analysis` and expanding it to fit offset sine waves, detect cycles from maxima, support cosine-like starts, and return offset, amplitude, angular frequency, phase, and a reference mid-time.
+
+### Resolved
+* Fixed coordinate transform handling for vectors pointing in the negative z-direction.
+
+### Changed
+* Relaxed range compatibility checks for units and promoted scipy from a test-only dependency to a runtime package dependency, aligning dependencies with actual package usage.
+* Cleaned up FMU test artifacts by removing generated FMU binaries from the examples folder, building FMUs into the test working directory instead, ignoring generated .dat files, and switching shared test fixtures to session scope.
+* Added or updated tests for the new controls behavior, sine fitting, transform handling, and FMU build workflow.
+* Included minor follow-up cleanup such as corrected example text typos, small README/docstring/formatting updates, and lockfile refreshes.
+
+
 ## [0.3.2] - 2026-02-02
 
 ### Added
@@ -139,7 +155,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 
 
 <!-- Markdown link & img dfn's -->
-[unreleased]: https://github.com/dnv-innersource/component-model/compare/v0.3.2...HEAD
+[unreleased]: https://github.com/dnv-innersource/component-model/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/dnv-innersource/component-model/compare/v0.3.2...v0.4.0
 [0.3.2]: https://github.com/dnv-innersource/component-model/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/dnv-innersource/component-model/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/dnv-innersource/component-model/compare/v0.2.0...v0.3.0

CITATION.cff

@@ -1,5 +1,5 @@
 title: component-model
-version: 0.3.2
+version: 0.4.0
 abstract: >-
     Constructs a Functional Mockup Interface component model from a python script (fulfilling some requirements).
 type: software

README.rst

@@ -301,7 +301,7 @@ Development Setup
 
 1. Install uv
 ^^^^^^^^^^^^^
-This project uses `uv` as package manager.
+This project uses ``uv`` as package manager.
 
 If you haven't already, install `uv <https://docs.astral.sh/uv/>`_, preferably using it's `"Standalone installer" <https://docs.astral.sh/uv/getting-started/installation/#__tabbed_1_2/>`_ method:
 
@@ -319,7 +319,7 @@ If you haven't already, install `uv <https://docs.astral.sh/uv/>`_, preferably u
 
 (see `docs.astral.sh/uv <https://docs.astral.sh/uv/getting-started/installation//>`_ for all / alternative installation methods.)
 
-Once installed, you can update `uv` to its latest version, anytime, by running:
+Once installed, you can update ``uv`` to its latest version, anytime, by running:
 
 .. code:: sh
 
@@ -381,7 +381,7 @@ Run ``uv sync -U`` to create a virtual environment and install all project depen
    **Note**: ``uv`` will create a new virtual environment called
    ``.venv`` in the project root directory when running ``uv sync -U``
    the first time. Optionally, you can create your own virtual
-   environment using e.g. ``uv venv``, before running ``uv sync -U``.
+   environment using e.g. ``uv venv``, before running ``uv sync -U``.
 
 
 5. (Optional) Activate the virtual environment

docs/source/conf.py

@@ -26,7 +26,7 @@
 author = "Siegfried Eisinger, Jorge Luis Mendez"
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.2"
+release = "0.4.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

examples/DrivingForce.fmu

@@ -64,23 +64,23 @@ def __init__(
         self._rpm0 = Variable(
             self,
             "wheels[0].motor.rpm",
-            "Angualar speed of wheel 1 in rad/s:",
+            "Angular speed of wheel 1 in rad/s:",
             causality="input",
             variability="continuous",
             start=f"{rpm1} 1/s",
         )
         self._rpm1 = Variable(
             self,
             "wheels[1].motor.rpm",
-            "Angualar speed of wheel 2 in rad/s:",
+            "Angular speed of wheel 2 in rad/s:",
             causality="input",
             variability="continuous",
             start=f"{rpm2} 1/s",
         )
         self._acc0 = Variable(
             self,
             "der(wheels[0].motor.rpm)",
-            "Angualar acceleration of wheel 1 in rad/s**2:",
+            "Angular acceleration of wheel 1 in rad/s**2:",
             causality="input",
             variability="continuous",
             start="0.0 1/s**2",
@@ -90,7 +90,7 @@ def __init__(
             Variable(
                 self,
                 "der(wheels[1].motor.rpm)",
-                "Angualar acceleration of wheel 2 in rad/s**2:",
+                "Angular acceleration of wheel 2 in rad/s**2:",
                 causality="input",
                 variability="continuous",
                 start="0.0 1/s**2",

examples/DrivingForce6D.fmu

@@ -30,7 +30,7 @@ allow-direct-references = true
 
 [project]
 name = "component-model"
-version = "0.3.2"
+version = "0.4.0"
 description = "Constructs a Functional Mockup Interface component model from a python script (fulfilling some requirements)."
 readme = "README.rst"
 requires-python = ">= 3.11"
@@ -66,13 +66,12 @@ dependencies = [
     "jsonpath-ng>=1.7.0",
     "pythonfmu>=0.7.0",
     "flexparser>=0.4",
-    "scipy-stubs>=1.17.0.0",
+    "scipy>=1.16",
 ]
 
 [project.optional-dependencies]
 test = [
-    "fmpy==0.3.21", # version 0.3.22 does so far (25.3.25) not workwhen installing through pip
-    "scipy>=1.16",
+    "fmpy>=0.3.21", # version 0.3.22 does so far (25.3.25) not workwhen installing through pip
     "matplotlib>=3.10",
     "plotly>=6.3",
     "libcosimpy>=0.0.5",
@@ -103,6 +102,7 @@ dev = [
     "sphinxcontrib-mermaid>=1.0.0",
     "myst-parser>=4.0",
     "furo>=2025.9",
+    "scipy-stubs>=1.17.0.0",
 ]
 
 [tool.uv]