Merge branch 'main' of github.com:modelica/fmi-standard into v3.0.x

Author: KarlWernersson

ISSUE_TEMPLATE.md .github/issue_template.mdISSUE_TEMPLATE.md renamed to .github/issue_template.md

@@ -1,3 +1,8 @@
+---
+name: Issue
+about: File an issue
+---
+
 <!--
 
 This project is used for the development of the FMI Standard (https://fmi-standard.org/)

PULL_REQUEST_TEMPLATE.md .github/pull_request_template.mdPULL_REQUEST_TEMPLATE.md renamed to .github/pull_request_template.md

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4.1.7
 
     - name: Build code snippets
       run: |
@@ -31,13 +31,13 @@ jobs:
     runs-on: windows-2022
     steps:
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4.1.7
 
     - run: |
         PowerShell -ExecutionPolicy Bypass -Command ./generate_figures.ps1
 
     - name: Create ZIP archive
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4.4.0
       with:
         name: schema-figures
         path: docs/images/schema/*.png
@@ -49,11 +49,11 @@ jobs:
     steps:
 
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4.1.7
       with:
         submodules: recursive
 
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4.1.8
       with:
         name: schema-figures
         path: docs/images/schema
@@ -88,7 +88,7 @@ jobs:
         cp docs/images/schema/*.png build/images/schema
 
     - name: Create ZIP archive
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4.4.0
       with:
         name: FMI-Specification
         path: build/*

.github/workflows/build-spec.yml

@@ -21,6 +21,8 @@ If you haven't already done so https://help.github.com/articles/cloning-a-reposi
 or your favorite Git client.
 To build the HTML document you have two alternatives.
 
+To open the repository in https://www.gitpod.io/[Gitpod], https://github.com/modelica/fmi-standard/fork[fork] the repository and open `https://gitpod.io/#https://github.com/<your-github-user-name>/fmi-standard`.
+
 `Alternative 1:` Docker (recommended)
 
 . Install https://www.docker.com/get-started[Docker]
@@ -259,12 +261,11 @@ master
 Follow these steps to create a (pre-)release:
 
 * update the FMI version in the schema, XML examples, and header files
-* update <<CHANGELOG.adoc#,CHANGELOG.adoc>>
-* download the `fmi-standard.zip` artifact from https://circleci.com/gh/modelica/fmi-standard[CirleCI] and check for completeness
+* download the `fmi-standard.zip` artifact from https://github.com/modelica/fmi-standard/actions and check for completeness
 * create a tag on `master` (e.g. `v3.0-rc.1`) and push it together with a commit to trigger the CI
 * create a new https://github.com/modelica/fmi-standard/releases[release] on GitHub for the tag
 ** check `This a pre-release` if it's not the final release
-** add the text from `CHANGELOG.adoc`
+** add a description of the changes
 ** add the version to `fmi-standard.zip` (e.g. `fmi-standard-3.0-rc.1.zip`) and upload it to the release
 
 == Corporate Contributor License Agreement

CONTRIBUTING.adoc

@@ -1,5 +1,5 @@
 Copyright (C) 2008-2011 MODELISAR consortium,
-              2012-2023 Modelica Association Project "FMI"
+              2012-2024 Modelica Association Project "FMI"
               All rights reserved.
 
 Source code or other data, such as C-header and XML-schema files, that

LICENSE.txt

@@ -27,9 +27,10 @@ The following https://github.com/modelica/fmi-standard/blob/main/docs/2_6_versio
 - https://github.com/modelica/fmi-ls-xcp[XCP] -- information for calibration and measurement
 - https://github.com/modelica/fmi-ls-bus[Network Communication] -- mapping of variables to buses
 - https://github.com/modelica/fmi-ls-struct[Structure] -- semantic grouping of variables
+- https://github.com/modelica/fmi-ls-ref[REF] -- stimuli and reference results
 
 == Copyright and License
 
-Code and documentation copyright (C) 2008-2011 the MODELISAR consortium and 2012-2023 the Modelica Association Project FMI.
+Code and documentation copyright (C) 2008-2011 the MODELISAR consortium and 2012-2024 the Modelica Association Project FMI.
 Code released under the https://opensource.org/licenses/BSD-2-Clause[2-Clause BSD License].
 Docs released under https://creativecommons.org/licenses/by-sa/4.0/[Attribution-ShareAlike 4.0 International].

README.adoc

@@ -1,11 +1,11 @@
 The https://fmi-standard.org/[Functional Mock-up Interface (FMI)] is a free standard that defines a container and an interface to exchange dynamic models using a combination of XML files, binaries and C code, distributed as a ZIP file.
-[[MAP,MAP]]It is supported by https://fmi-standard.org/tools/[more than 170 tools] and maintained as a https://www.modelica.org/projects[Modelica Association Project] (MAP FMI).
+[[MAP,MAP]]It is supported by https://fmi-standard.org/tools/[more than 200 tools] and maintained as a https://www.modelica.org/projects[Modelica Association Project] (MAP FMI).
 https://github.com/modelica/fmi-standard/releases[Releases] and https://github.com/modelica/fmi-standard/issues[issues] can be found on https://github.com/modelica/fmi-standard[github.com/modelica/fmi-standard].
 
 {empty} +
 {empty}
 
-Copyright (C) 2008-2011 MODELISAR Consortium and 2012-2023 The Modelica Association Project FMI.
+Copyright (C) 2008-2011 MODELISAR Consortium and 2012-2024 The Modelica Association Project FMI.
 
 This document is licensed under the Attribution-ShareAlike 4.0 International license.
 The code is released under the 2-Clause BSD License.

docs/0___preamble.adoc

@@ -43,22 +43,22 @@ The following features have been removed:
 
 * The asynchronous mode for FMUs known from FMI 2.0 CS: this mode was not supported by tools and it can be suitably replaced by Co-Simulation implementations that control the asynchronous computation of FMUs via separate processes/threads created for each FMU.
 
-* The FMI `fmi2SetRealInputDerivatives` function: replaced by enabling the setting of inputs in <<IntermediateUpdateMode>>.
+* The FMI function `fmi2SetRealInputDerivatives`: replaced by enabling the setting of inputs in <<IntermediateUpdateMode>>.
 
 Parallel to the new standard features, the FMI Design Community has improved the standard quality by:
 
 * modernizing the development methodology (e.g. moving to github and following the github process) and a text-based source format,
 
-* publishing the FMI Standard now primarily as html to support easier navigation within the document and viewing on a wider range of devices,
+* publishing the FMI Standard now primarily as HTML to support easier navigation within the document and viewing on a wider range of devices,
 
 * supplying a large set of continuously validated Reference FMUs, and
 
 * integrating within the FMI Standard only validated C-code, XML and XSD snippets to reduce redundancy and ensure correctness.
 
 
-==== Changes in FMI 3.0.1 [[fmi-301]]
+==== Changes in FMI 3.0.x
 
-Clarifications and fixes in FMI 3.0.1 are listed in the https://github.com/modelica/fmi-standard/releases[Release notes on Github.]
+Clarifications and fixes of all FMI 3.0 patch releases (FMI 3.0.x) are listed in the https://github.com/modelica/fmi-standard/releases[release notes on GitHub].
 
 === Overview
 
@@ -119,6 +119,7 @@ image::images/co-simulation-data-flow.svg[width=40%, align="center"]
 The Scheduled Execution interface exposes individual <<model-partition, model partitions>>.
 A scheduler provided by the <<importer>> can control the execution of each model partition separately.
 In some ways the Scheduled Execution interface has similarities to the Model Exchange interface: the first externalizes a scheduling algorithm usually found in a controller algorithm (see <<fmi-for-scheduled-execution>>) and the second interface externalizes the ODE/DAE solver.
+_[See also https://modelica.github.io/fmi-guides/main/fmi-guide/#_use_cases_for_scheduled_execution[Use-cases for Scheduled Execution] in the FMI 3.0 Implementers' Guide.]_
 
 .Schematic view of data flow between user, the scheduler of the importer and model partitions of the FMU for Scheduled Execution
 [#figure-scheduled-execution-data-flow]
@@ -290,7 +291,7 @@ Allocator must free::
 All memory (and other resources) allocated by the FMU are freed (released) by the FMU.
 Likewise, resources allocated by the importer are released by the importer.
 +
-Reason: this helps to prevent memory leaks and runtime errors due to incompatible runtime environments for different components.
+Reason: This helps to prevent memory leaks and runtime errors due to incompatible runtime environments for different components.
 
 Immutable strings::
 All strings passed as arguments or returned are read-only and must not be modified by the receiver.

docs/1___overview.adoc

@@ -26,20 +26,20 @@ An ordering is defined on latexmath:[\mathbb{\text{T}}] that leads to the notati
 |Description
 
 ^|latexmath:[t_1 < t_2]
-|latexmath:[(t_{\mathit{R1}},t_{\mathit{I1}}) < (t_{\mathit{R2}}, t_{\mathit{I2}})\ \Leftrightarrow \ t_{\mathit{R1}} < t_{\mathit{R2}}\ \textbf{or} \ t_{\mathit{R1}}= t_{\mathit{R2}} \ \textbf{and} \ t_{\mathit{I1}} < t_{\mathit{I2}}]
+|latexmath:[(t_{\mathit{R}\hspace{0.1em}1},t_{\mathit{I}\hspace{0.1em}1}) < (t_{\mathit{R}\hspace{0.1em}2}, t_{\mathit{I}\hspace{0.1em}2})\ \Leftrightarrow \ t_{\mathit{R}\hspace{0.1em}1} < t_{\mathit{R}\hspace{0.1em}2}\ \textbf{or} \ ( t_{\mathit{R}\hspace{0.1em}1}= t_{\mathit{R}\hspace{0.1em}2} \ \textbf{and} \ t_{\mathit{I}\hspace{0.1em}1} < t_{\mathit{I}\hspace{0.1em}2}] )
 |latexmath:[t_1] is before latexmath:[t_2]
 
 ^|latexmath:[t_1 = t_2]
-|latexmath:[(t_{\mathit{R1}},t_{\mathit{I1}}) = (t_{\mathit{R2}},t_{\mathit{I2}}) \ \Leftrightarrow  t_{\mathit{R1}}= t_{\mathit{R2}}\ \textbf{and} \ t_{\mathit{I1}} = t_{\mathit{I2}}]
+|latexmath:[(t_{\mathit{R}\hspace{0.1em}1},t_{\mathit{I}\hspace{0.1em}1}) = (t_{\mathit{R}\hspace{0.1em}2},t_{\mathit{I}\hspace{0.1em}2}) \ \Leftrightarrow  t_{\mathit{R}\hspace{0.1em}1}= t_{\mathit{R}\hspace{0.1em}2}\ \textbf{and} \ t_{\mathit{I}\hspace{0.1em}1} = t_{\mathit{I}\hspace{0.1em}2}]
 |latexmath:[t_1] is identical to latexmath:[t_2]
 
 ^|latexmath:[t^{+}]
-|latexmath:[{(t_R,t_I)}^{+} \Leftrightarrow (\lim_{\mathit{\epsilon \rightarrow 0}}{\left(t_R + \varepsilon \right),t_{\mathit{Imax}})}]
+|latexmath:[{(t_R,t_I)}^{+} \Leftrightarrow (\lim_{\mathit{\varepsilon \rightarrow 0}}{\left(t_R + \varepsilon \right),t_{\mathit{Imax}})}]
 |right limit at latexmath:[t].
 latexmath:[t_{\mathit{Imax}}] is the largest occurring integer index of super-dense time at this latexmath:[t_R]
 
 ^|latexmath:[^-t]
-|latexmath:[^{-}{(t_R,t_I)} \Leftrightarrow (\lim_{\mathit{\epsilon \rightarrow 0}}{\left( t_R - \varepsilon \right),0)}]
+|latexmath:[^{-}{(t_R,t_I)} \Leftrightarrow (\lim_{\mathit{\varepsilon \rightarrow 0}}{\left( t_R - \varepsilon \right),0)}]
 |left limit at latexmath:[t]
 
 ^|latexmath:[v^+(t)]
@@ -58,9 +58,9 @@ latexmath:[t_{\mathit{Imax}}] is the largest occurring integer index of super-de
 \end{cases}
 \Leftrightarrow
 \begin{cases}
- v(^-t) & \text{ during } v(\left( t_R, 0 \right)) \text{, v not clocked }  \\
- v(\left( t_R,t_I - 1 \right)) & \text{ for } v(\left( t_R,t_I \right)) \text{ with } I > 0  \text{, v not clocked } \\
- v \text{ at previous tick of k } & \text{ if } v \text{ for clocked variable } v \text{ of clock k}
+ v(^-t) & \text{ during } v(\left( t_R, 0 \right)) \text{, } v \text{ not clocked }  \\
+ v(\left( t_R,t_I - 1 \right)) & \text{ for } v(\left( t_R,t_I \right)) \text{ with } t_I > 0  \text{, } v \text{ not clocked } \\
+ v \text{ at previous tick of k } & \text{ if } v \text{ is a clocked variable of clock k}
 \end{cases}
 ]
 a|previous value