Skip to content

Commit

Permalink
eFMI® Standard 1.0.0 Beta 1
Browse files Browse the repository at this point in the history
  • Loading branch information
christoff-buerger committed Jul 11, 2024
1 parent 70a2454 commit 6366e87
Show file tree
Hide file tree
Showing 10 changed files with 17,459 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When you submit a pull request, a bot will automatically determine whether you n

Please check the available labels and use them. The label descriptions clarify the kind of issues that can be reported. _Every_ issue must be labeled with _one_ collated-to category label (`website`, `eFMI Standard`, `infrastructure`) denoting the artifacts and/or functionality of the repository the issue is about. The issue also _must_ be categorized if it is a general question, enhancement request or an actual bug (`question`, `enhancement` and `bug` labels). The `documentation` label is optional and used to denote that the issue is about the documentation of its collated-to category. The `invalid` label is used to denote issues that already exists, doesn't seem right or won't be worked on.

The `eFMI Standard` label is used to denote issues of publically released stable and candidate-draft _eFMI Standard_ versions. If you report any standard issues, please denote the troublesome version of the standard first in the issue title, e.g., _"eFMI 1.0.0 Alpha 4: The links in Chapter Foo-Bar are broken"_. And don't forget to add a categorization as explained in the previous paragraph (`bug`, `ehancement` or `question` label).
The `eFMI Standard` label is used to denote issues of publically released stable and candidate-draft _eFMI Standard_ versions. It can be used by the public -- i.e., individuals and organizations that are not part of the [Modelica Association Project eFMI](https://www.efmi-standard.org/about/) -- to report issues or feature requests they found in publicly released _eFMI Standard_ versions. If you report any standard issues, please denote the troublesome version of the standard first in the issue title, e.g., _"eFMI Standard 1.0.0 Alpha 4: The links in Chapter Foo-Bar are broken"_. And don't forget to add a categorization as explained in the previous paragraph (`bug`, `ehancement` or `question` label). We will provide feedback if we consider your issue worthwhile and tranferred it to the non-public _eFMI Standard_ development repository or not.

## Branch protection and commits/pull requests

Expand Down
5 changes: 4 additions & 1 deletion content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,14 @@ <h1 class="mb-4"><i>The</i> open standard for model-driven development of advanc
</div>

<div class="btn-group btn-group-lg">
<a class="btn btn-outline-primary text-nowrap" href="/media/home/eFMI-Standard-1.0.0-Alpha-4.html"><i class="fa-solid fa-file-lines me-2"></i>eFMI® Standard 1.0.0 Alpha 4</a>
<a class="btn btn-outline-primary text-nowrap" href="/media/home/eFMI-Standard-1.0.0-Beta-1.html"><i class="fa-solid fa-file-lines me-2"></i>eFMI® Standard 1.0.0 Beta 1</a>
<button type="button" class="btn btn-outline-primary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="/media/resources/eFMI-Standard-1.0.0-Beta-1.zip"><i class="fa-solid fa-file-zipper me-2"></i>eFMI® Standard 1.0.0 Beta 1 (zip)</a></li>
<li><a class="dropdown-item" href="/media/home/eFMI-Standard-1.0.0-Beta-1.html"><i class="fa-solid fa-file-lines me-2"></i>eFMI® Standard 1.0.0 Beta 1 (html)</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="/media/resources/eFMI-Standard-1.0.0-Alpha-4.zip"><i class="fa-solid fa-file-zipper me-2"></i>eFMI® Standard 1.0.0 Alpha 4 (zip)</a></li>
<li><a class="dropdown-item" href="/media/home/eFMI-Standard-1.0.0-Alpha-4.html"><i class="fa-solid fa-file-lines me-2"></i>eFMI® Standard 1.0.0 Alpha 4 (html)</a></li>
</ul>
Expand Down
6 changes: 6 additions & 0 deletions content/news/2023-05-10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Annual project report 2022
date: 2023-05-10
---

MAP eFMI published its [annual project report of 2022](/media/resources/MAP-eFMI-annual-project-report-2022.pdf) presented at the Modelica Association assembly meeting 2023.
6 changes: 6 additions & 0 deletions content/news/2024-05-28.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Annual project report 2023
date: 2024-05-28
---

MAP eFMI published its [annual project report of 2023](/media/resources/MAP-eFMI-annual-project-report-2023.pdf) presented at the Modelica Association assembly meeting 2024.
36 changes: 36 additions & 0 deletions content/news/2024-07-02.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: eFMI® Standard 1.0.0 Beta 1 (candidate-draft) released
date: 2024-07-02
---

The next [candidate-draft](/standard/#release-cycle-and-versioning), the _eFMI® Standard 1.0.0 Beta 1_, for the first official release of the _eFMI® Standard_ has been released! You can download it from the [Home page](/) and the [Resources page](/resources/#_efmi-standard_-releases).

This is the first Beta release since the last candidate-draft, the Alpha 4. We are therefore now in beta phase, with each beta finalizing one model representation chapter.

This release focuses on the Behavioral Model representation, whose specification has been finalized and significantly extended and improved to achieve semantic completeness. Among many features, eFMI® Behavioral Models support:

- testing of any other eFMI® model representation like Algorithm, Production or Binary Code
- equidistant and variable time grid scenarios, the former with well-defined acceptable time-deviation and the latter with well-defined interpolation semantic
- tolerances configurations defining the absolute and relative error tolerances of variables for various floating-point precisions
- mapping configurations defining how to map variables of any dimensionality (scalar, vector, matrix, or higher dimensionality) to reference trajectories stored in CSV files
- proper handling of time grids w.r.t. actual (i.e., used to conduct a test) and presupposed (i.e., assumed by the test provider) sampling times
- proper handling of units of reference trajectories and tolerances
- testing of error signals, including test scenarios with expected errors
- test scenarios with runtime recalibration of tunable parameters
- clear requirements on test environments and definition of how to conduct a test

Besides the _"Behavioral Model representation"_ Chapter, Beta 1 also finalizes the PDF layout and support chapters, like:

- footer with standard version, current page number and total, licensing and website link
- use of single open source font family
- blank pages for correct printing
- _"Legal information"_ Chapter, now with colophon stating the licenses of used open source fonts, trademarks and disclaimer
- the title page, now with eFMI® logo.

There are only minor improvements in the other chapters; they will be focused on and finalized in individual future Beta candidate-drafts. The plan for Beta 2 is to wrap up the current preamble with _"Abstract"_, _"Overview"_ and _"Introduction"_ Chapters into a single _"Overview"_ Chapter, wrap up and finalize Chapter 1, _"General Concepts"_, and Chapter 2, _"eFMU container architecture"_, into a single _"Common concepts"_ chapter, and finalize Chapter 3.1, the _"Algorithm Code manifest"_.

Testing -- and how to define tests, store references, integrate the tooling subject to testing, and make sure different test environments agree on the test results for a certain tooling -- is certainly a hot topic for any Modelica Association standard and project. We sincerely hope that the _eFMI® Standard 1.0.0 Beta 1_ provides an excellent starting point for discussion and insights on the challenges of achieving well-defined semantics and completeness, even if "just" for something as "simple" as testing sampled data systems.

If you have any general questions, feedback or improvement proposals for the _eFMI® Standard_, please follow the [reporting specification issues and new feature requests guidelines on our website](https://www.efmi-standard.org/standard/#reporting-specification-issues-and-new-feature-requests) or contact us on our _public_ mailing list, [`[email protected]`](https://groups.google.com/g/efmi-info) (no Google account required).

**Your feedback is very welcome!**
3 changes: 3 additions & 0 deletions content/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ There exists no current stable release yet. The first release will be the upcomi

The next major upcoming _eFMI Standard_ release is version 1.0.0; below are the candidate-drafts for it. Please see [the release cycle](/standard/#release-cycle-and-versioning) for details about the release schedule and for an estimation of maturity of candidate-drafts.

- _eFMI Standard 1.0.0 Beta 1 (2024-07-02)_:
- [_eFMI Standard 1.0.0 Beta 1_ (zip)](/media/resources/eFMI-Standard-1.0.0-Beta-1.zip)
- _eFMI Standard 1.0.0 Alpha 4 (2021-02-22)_:
- [_eFMI Standard 1.0.0 Alpha 4_ (zip)](/media/resources/eFMI-Standard-1.0.0-Alpha-4.zip)
- [Specification text with change-marks to previous draft (PDF)](/media/resources/eFMI-Standard-1.0.0-Alpha-4-specification-text-changemarks.pdf)
Expand All @@ -43,6 +45,7 @@ MAP eFMI provides a set of open source tools and libraries to foster the eFMI ec

**Annual project reports at Modelica Association assembly meetings**

- [Annual project report 2023 (PDF)](/media/resources/MAP-eFMI-annual-project-report-2023.pdf)
- [Annual project report 2022 (PDF)](/media/resources/MAP-eFMI-annual-project-report-2022.pdf)
- [Annual project report 2021 (PDF)](/media/resources/MAP-eFMI-annual-project-report-2021.pdf)

Expand Down
6 changes: 3 additions & 3 deletions content/standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ _eFMI Standard_ releases and supporting artefacts and tooling are published on t

### General release organization

We are currently in the second year of our release cycle. The latest candidate-draft is the _eFMI Standard 1.0.0 Alpha 4_.
We are currently in the second year of our release cycle. The latest candidate-draft is the _eFMI Standard 1.0.0 Beta 1_.

We aim to release a new major eFMI version (i.e., _eFMI Standard_ and related tooling) about every 2 years; that is our planned release cycle. In the first year, new features are collected and defined, i.e., we design the:

Expand Down Expand Up @@ -69,8 +69,8 @@ MAP eFMI therefore reserves the right of -- and in fact very likely will introdu

## Reporting specification issues and new feature requests

You can report any specification issues you found via the [GitHub issue tracker](https://github.com/modelica/efmi-standard.org/issues). Before opening any new issues, please consult the [contributing and repository policy](https://github.com/modelica/efmi-standard.org/blob/main/CONTRIBUTING.md) first. If you create a new issue, please use the label `eFMI Standard` and denote the troublesome version of the standard first in the issue title, e.g., _"eFMI 1.0.0 Alpha 4: The links in Chapter Foo-Bar are broken"_. Further, use the `bug` label for real specification bugs, the `enhancement` label for general new feature requests and the `question` label for general discussions.
If you are not a project member, you have no access to the repository we use to develop the _eFMI Standard_. Nevertheless, you can report any specification issues you found via the [GitHub issue tracker of the public website repository](https://github.com/modelica/efmi-standard.org/issues). Before opening any new issues, please consult the [contributing and repository policy](https://github.com/modelica/efmi-standard.org/blob/main/CONTRIBUTING.md) first. If you create a new issue, please use the label `eFMI Standard` and denote the troublesome version of the standard first in the issue title, e.g., _"eFMI Standard 1.0.0 Alpha 4: The links in Chapter Foo-Bar are broken"_. Further, use the `bug` label for real specification bugs, the `enhancement` label for general new feature requests and the `question` label for general discussions. We will provide feedback if we consider your issue worthwhile and tranferred it to the non-public _eFMI Standard_ development repository or not.

If your organization is regularly contributing or checking for issues and releases of the _eFMI Standard_, or just considers eFMI as an important technology in their field of application, you should consider joining MAP eFMI. To that end, you can find an overview of the project objectives and members on the [About page](/about/#map-efmi-members) and the project bylaws and application forms on the [Resources page](/resources/#project-organization).

Joining MAP eFMI as a member is the only way for organizations to get an official saying in standardization decisions, direct the future eFMI development and get early access to in-development versions of the _eFMI Standard_.
Joining MAP eFMI as a member is the only way for organizations to get an official saying in standardization decisions, direct the future eFMI development and get early access to in-development versions of the _eFMI Standard_. Only members have access to the _eFMI Standard_ development repository with the not _yet_ published, current development branch and source code.
Loading

0 comments on commit 6366e87

Please sign in to comment.