Skip to content

Commit

Permalink
Merge and consolidate changes sections
Browse files Browse the repository at this point in the history
  • Loading branch information
pmai committed Oct 12, 2024
1 parent 7ea9081 commit cadf56c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 51 deletions.
23 changes: 0 additions & 23 deletions docs/0___preamble.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,26 +79,3 @@ The standard is comprised of a set of XML-based formats to describe a network of

* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in RFC 2119 [RFC2119].
* Non-normative text is given in square brackets in italic font: [ _especially examples are defined in this style._ ].
= What is new in SSP 2.0
The SSP development group has provided this update to the SSP standard in reaction to the release of FMI 3.0 as well as to new end user requirements.
Even though SSP 2.0 is seen as a major version update, SSP 1.0 artifacts are still seen as fully compliant to the SSP 2.0 release. Naturally, however, SSP 2.0 compliant artifacts are not necesarali compliant to the SSP 1.0 schema.

The SSP 2.0 release is primarily focused on supporting the updates of FMI 3.0; however, a number of minor but significant changes related to supporting, for example, incremental development as well non-fmi components are introduced. An overview of the changes are provided in the two bulleted lists below: the first aggregating features related to FMI 3.0 and the second to non-FMI related new requirements.
Many different advancements to the specification have been discussed; however, the SSP 2.0 specification has been deduced as a least-common denominator for the exchange of simulation packages that is able to provide value for both end-users and tool suppliers.

== FMI 3.0 related updates
* Basic types, such as Float32.
* Scheduled execution (component implementation attribute).
* Clocked signals.
* Arrays. Support for expressing arrays in connectors in the SSD as well as in the SSV and SSB.
* The expression of annotations are aligned to that of FMI 3.0 and SSP Traceability.

== Non-FMI 3.0 related updates
* Optional inner view connector coordinates. This feature enables more advanced graphical editing of SSP models.
* Initial meta-data support from "SSP Traceability" project. First step in aligning SSP with SSP Traceability. Allows the end user to capture, for example, life-cycle information in the SSP package.
* Optional support for representing Modelica components and connectors in SSP. SSP is not FMI exclusive and SSP now nativly supports Modelica models as components.
* The component source is made optional to support the usage of system structure descriptions for simulation architecture design without available component implementations. Furthermore, connectors with kind="local" are added to the specification. This, for example, further enriches SSP for architecting purposes.
* General clarifications and bug fixes.
* Constant and structuralParameter are added as allowed connector kinds. This expansion further aligns SSP 2.0 to FMI and its constructs.

57 changes: 29 additions & 28 deletions docs/1___overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,36 +143,37 @@ We would also like to thank all persons that provided feedback during the intern

=== Changes in 2.0.0

The following changes were performed as part of the 2.0.0 major release:
This major release of the SSP standard provides support for FMI 3.0, as well as other enhancements in response to new end-user requirements for architectural design, traceability, incremental development, and support of Modelica models as components.

Even though SSP 2.0 is a major version release, all SSP 1.0 conforming artifacts are considered to be fully conforming to SSP 2.0.
SSP 2.0 conforming artifacts are only compliant to the SSP 1.0 standard if they use a 1.0 version number and only use features available in SSP 1.0.

* Support for FMI 3
** Basic types, such as Float32.
** Scheduled execution (component implementation attribute).
** Clocked signals.
** Array connectors.
* Optional inner view connector coordinates (wen inner view is different from outer view).
* Initial meta-data support from "SSP Traceability" project.
* Optional support for representing Modelica components and connectors in SSP.
* Clarifications and bug fixes.

* Fix HTML check by @beutlich in https://github.com/modelica/ssp-standard/pull/2
* Fix link to 2-clause BSD license by @pmai in https://github.com/modelica/ssp-standard/pull/6
* Fix missing type of Connector name attribute (#3) by @pmai in https://github.com/modelica/ssp-standard/pull/4
* Add initial draft to include new FMI 3.0 data types by @pmai in https://github.com/modelica/ssp-standard/pull/1
* Specify alias handling for FMI 3.0 by @pmai in https://github.com/modelica/ssp-standard/pull/5
* Add constant and structuralParameter as connector kinds by @pmai in https://github.com/modelica/ssp-standard/pull/10
* Allow mixed content in annotations, as in FMI 3.0 by @pmai in https://github.com/modelica/ssp-standard/pull/13
* Clarify type conversion handling by @pmai in https://github.com/modelica/ssp-standard/pull/21
* Variable defined as connector local by @DagBruck in https://github.com/modelica/ssp-standard/pull/22
* Add XML schema checking to build process by @pmai in https://github.com/modelica/ssp-standard/pull/25
* Initial support for array connectors by @pmai in https://github.com/modelica/ssp-standard/pull/8
* Make component source optional by @peter-lobner in https://github.com/modelica/ssp-standard/pull/18
* Uniqueness of root SSDs by @DagBruck in https://github.com/modelica/ssp-standard/pull/23
* Clarification parameter designation by @DagBruck in https://github.com/modelica/ssp-standard/pull/27
* Update 1___overview.adoc by @dweil in https://github.com/modelica/ssp-standard/pull/32
* Initial draft of clock support by @pmai in https://github.com/modelica/ssp-standard/pull/24
* Add ScheduledExecution to implementation attribute by @pmai in https://github.com/modelica/ssp-standard/pull/38
The following changes were performed as part of the 2.0.0 major release:

* Support for FMI 3.0
** Support for the new basic data types: Float32/64, and [U]Int8/16/32/64.
** Support for the new scheduled execution implementation kind in the component implementation attribute.
** Support for clocks as a new connector kind, and clocked variables/connectors.
** Support for arrays in connectors and connections in the SSD, as well as in the SSV and SSB file formats.
** Support for structural parameters with the new connector kind `structuralParameter`.
** Support for the redesigned alias variable handling in FMI 3.0.
* Architectural design features
** The component source attribute is now optional to support the usage of system structure descriptions for simulation architecture design without available component implementations.
** New connector kinds `local`, and `constant` are added to the specification, to support more encompassing interface specifications for components, and further parameter propagation.
** Support for optional inner view connector coordinates, in addition to the outer view connector coordinates.
This feature enables more advanced graphical editing of SSP models.
* Traceability and meta-data features
** Integration of the `MetaData` element developed as part of the SSP Traceability layered standard into the core standard.
This allows the integration of arbitrary meta-data and digital signatures into the SSP file formats.
** Support for mixed content in annotations, as in FMI 3.0 and the SSP Traceability layered standard.
* Support for Modelica
** Support in the core standard for Modelica models as components
** Support for the mapping of complex Modelica types in interfaces to binary connectors in SSP
* General clarifications and bug fixes
** Fix missing type of Connector name attribute in https://github.com/modelica/ssp-standard/pull/4
** Clarify type conversion handling in https://github.com/modelica/ssp-standard/pull/21
** Clarify uniqueness of root SSDs in https://github.com/modelica/ssp-standard/pull/23
** Clarify hierarchical parameter name resolution in https://github.com/modelica/ssp-standard/pull/27

=== Changes in 1.0.1

Expand Down

0 comments on commit cadf56c

Please sign in to comment.