Skip to content

Update copyrights, unify naming, prepare RC1 #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2019-2023 Modelica Association Project "SSP"
Copyright (C) 2019-2025 Modelica Association Project "SSP"
All rights reserved.

Source code or other data, such as C-header and XML-schema files, that
Expand Down Expand Up @@ -30,7 +30,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
----------------------------------------------------------------------------


The SSP Traceability specification is released under the CC-BY-SA
The SSP Layered Standard Traceability is released under the CC-BY-SA
(Creative Common Attribution ShareAlike 4.0 International):


Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# SSP Traceability Specification
# SSP LS Traceability

[![Build Specification](https://github.com/modelica/ssp-ls-traceability/workflows/Build%20Specification/badge.svg)](https://github.com/modelica/ssp-ls-traceability/actions?query=workflow%3A%22Build+Specification%22)

This repository contains the current prototyped draft specification
for an [SSP][]-based layered standard for simulation traceability
information exchange. Note that this specification is actively
being worked on, and thus subject to change without notice.
This repository contains the [SSP][]-based layered standard for
simulation traceability information exchange. Note that this
specification is actively being worked on, and thus subject to
change without notice.

The [specification][spec] is maintained on [GitHub][github] and is
published [here][spec]. It is based on the [SSP 2.0][SSP20] standard,
Expand Down
4 changes: 2 additions & 2 deletions STC.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@

Locators, arcs and the link itself can further specify their semantic
meaning through optional role or arcrole attributes. The SSP
Traceability specification currently provides no predefined roles.
Layered Standard Traceability currently provides no predefined roles.

All individual elements and attributes are as specified in the XLink
specification.
Expand All @@ -371,7 +371,7 @@
It identifies a particular piece of information through an URI, that is
taking part in the linking relationship. Locators can further specify
their semantic meaning through an optional role attribute. The SSP
Traceability specification currently provides no predefined roles.
Layered Standard Traceability currently provides no predefined roles.
</xs:documentation>
</xs:annotation>
<xs:complexType>
Expand Down
86 changes: 78 additions & 8 deletions specification/0___preamble.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,82 @@
The SSP Traceability Specification is a free specification intended as a third-party layered standard upon SSP 2.0 to support traceability of simulation tasks.
This is a development version of the specification.
Document version: 1.0-rc.1

May 19, 2025

This document is the first release candidate of release 1.0 of the SSP Layered Standard Traceability (SSP-LS-Traceability).

This specification, as well as supporting XML schema files, is provided on the SSP site (https://ssp-standard.org/).
https://github.com/modelica/ssp-ls-traceability/releases[Releases] and https://github.com/modelica/ssp-ls-traceability/issues[issues] can be found on https://github.com/modelica/ssp-ls-traceability[github.com/modelica/ssp-ls-traceability].

{empty} +
{empty}
Contact the SSP development group at [email protected].

<<<

History / Road Map

[width="100%",cols="18%,12%,70%",]
|===
|Version |Date |Remarks
|1.0-rc.1 |2025-05-19 |First Release Candidate of SSP-LS-Traceability
|===

Please report issues that you find with this specification to [email protected].

<<<

*License of this document*

Copyright © 2016 – 2025 Modelica Association Project “SSP”

This document is provided “as is” without any warranty.
It is licensed under the CC-BY-SA (Creative Commons Attribution-Sharealike 4.0 International) license, which is the license used by Wikipedia.
The human-readable summary of the license text from http://creativecommons.org/licenses/by-sa/4.0/ is as follows:

You are free to:

____
*Share* — copy and redistribute the material in any medium or format

*Remix* — remix, transform, and build upon the material for any purpose, even commercially.

The licensor cannot revoke these freedoms as long as you follow the license terms.
____

Under the following terms:

____
*Attribution* — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

*Share Alike* — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
____

The legal license text and disclaimer is available at:

http://creativecommons.org/licenses/by-sa/4.0/legalcode

*Note:*

____
Article (3a) of this license requires that modifications of this work must clearly label, demarcate or otherwise identify that changes were made.

The XML schema files that accompany this document are available under the BSD 2-Clause license (https://opensource.org/license/bsd-2-clause/).

Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights.
Modelica Association shall not be held responsible for identifying such patent rights.

If you have improvement suggestions, please send them to the SSP development group at [email protected].
____

<<<

*Abstract*

The SSP Layered Standard Traceability is a layered standard provided by MAP SSP upon SSP 2.0 to support traceability of simulation tasks.
The standard is comprised of a set of XML-based formats to interchange process-relevant resources and information in the sense of process metadata for Credible Decision Processes and Credible Simulation Processes, as well as abritrary further metadata as part of SSP packages used to exchange the structural and parametrization aspects of a system.

<<<

////
Copyright notice and license information will go here.
////
*Conventions used in this Document*

{empty}
* 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._ ].
26 changes: 8 additions & 18 deletions specification/1___introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ It is therefore important that design decisions are based on reliable informatio
In order to make design decisions based on credible simulation results, it is essential that underlying simulation tasks are planned, executed and documented in a transparent and comprehensible manner and that there is a high degree of confidence in the correctness and validity of simulation results.
This is essential not only to make reliable design decisions (__quality assurance__), but also to be able to understand design decisions retrospectively (__traceability__).

Improving traceability of decisions and simulations is the core objective of the SSP Traceability specification, based on consistent and compatible documentation of decision processes and simulation process that produces the decision-relevant simulation results.
Other goals of the SSP Traceability specification are to provide the ability to re-run a simulation later and to provide the ability to re-use parts of the simulation setup for similar simulations (__reusability__).
Improving traceability of decisions and simulations is the core objective of the SSP Layered Standard Traceability, based on consistent and compatible documentation of decision processes and simulation process that produces the decision-relevant simulation results.
Other goals of the SSP Layered Standard Traceability are to provide the ability to re-run a simulation later and to provide the ability to re-use parts of the simulation setup for similar simulations (__reusability__).

=== Credible Simulation Process Framework

The SSP Traceability Specification applies in a __Credible Simulation Process Framework__ as procedural framework, which consists of a __Credible Decision Process__ and a __Credible Simulation Process__, coupled by a __Simulation Request__ and a __Simulation Delivery.__
The SSP Layered Standard Traceability applies in a __Credible Simulation Process Framework__ as procedural framework, which consists of a __Credible Decision Process__ and a __Credible Simulation Process__, coupled by a __Simulation Request__ and a __Simulation Delivery.__

As the traceability of decision and simulation processes improve by applying the SSP Traceability Specification, it is expected that the reliability and credibility of simulation results will increase.
As the traceability of decision and simulation processes improve by applying the SSP Layered Standard Traceability, it is expected that the reliability and credibility of simulation results will increase.
This is expected not only when decisions and simulations are performed within a company, but also when the Credible Simulation Process Framework is spread across companies and when simulation results are requested, exchanged and shared across companies.
Since the commissioning, preparation and execution of a simulation in that case are usually carried out by different persons or departments, sometimes even by different companies, a common understanding of the simulation task and the objectives of the simulation is essential for the quality and credibility of simulation results.
Traceable documentation of simulation requests and simulation deliveries is therefore just as important as traceable documentation of the decision processes and simulation processes themselves.

=== Applying SSP Traceability

The SSP Traceability Specification defines and describes a concept for assuring traceability for the processes of the Credible Simulation Process Framework.
The specification proposes to document Credible Decision Processes and Credible Simulation Processes by binding __(gluing)__ together all process-relevant resources and information in the sense of process metadata by means of appropriate SSP Traceability files for Credible Decision Processes and Credible Simulation Processes.
The essential core of the SSP Traceability Specification document is the documentation of the appropriate set of SSP Traceability file data formats.
The SSP Layered Standard Traceability defines and describes a concept for assuring traceability for the processes of the Credible Simulation Process Framework.
The standard proposes to document Credible Decision Processes and Credible Simulation Processes by binding __(gluing)__ together all process-relevant resources and information in the sense of process metadata by means of appropriate SSP Traceability files for Credible Decision Processes and Credible Simulation Processes.
The essential core of the SSP Layered Standard Traceability document is the documentation of the appropriate set of SSP Traceability file data formats.

=== Document structure

Expand All @@ -35,17 +35,7 @@ The detail description of the SSP Traceability data formats is subject of <<sec-
<<sec-dtmd>> describes how the SSP Traceability data format for documenting Credible Decision Processes are structured and <<sec-stmd>> describes the structure of SSP Traceability data formats for the documentation of Credible Simulation Processes.
<<sec-srmd>> additionally describes a data format for documenting metadata of individual resources in the sense of SSP Traceability.
<<sec-ssptraceabilitypackaging>> describes how SSP Traceability files can be bundled into an SSP Traceability package.
The SSP traceability specification concludes with a list of other applicable documents such as relevant standards and referenced literature.
The SSP Layered Standard Traceability concludes with a list of other applicable documents such as relevant standards and referenced literature.

CAUTION: High-quality documentation of simulation tasks using the SSP traceability mechanisms can only reflect the quality and consistency of the simulation task actually performed to the maximum.
However, the quality of the documentation does not guarantee the quality of the performed process.

=== Conventions used in this document

* The version number of this specification is to be interpreted according to the _Semantic Versioning Specification (SemVer) 2.0.0_ <<SEMVER200>>.

* Non-normative text is given in square brackets in italic font: _[Especially examples are defined in this style.]_

* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *NOT RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in _RFC 2119_ <<RFC2119>>.

* All name spaces and reverse domain notation domain names used in this draft version of this document are subject to change once the draft is finalized.
2 changes: 1 addition & 1 deletion specification/2___framework.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This information transfer is referred to as __Simulation Delivery__ in <<im-cred
For more information on the processes of the Credible Simulation Process Framework, see Appendix Part H of the prostep ivip SmartSE Recommendation v3 (<<CSP>>).

__Note: The Credible Simulation Process Framework actually includes more than just Credible Decision Process and Credible Simulation Process.
However, the SSP Traceability specification currently only supports traceability with respect to the Credible Decision Process and the Credible Simulation Process.__
However, the SSP Layered Standard Traceability currently only supports traceability with respect to the Credible Decision Process and the Credible Simulation Process.__

[#im-crediblesimulationprocessframework]
.Credible Simulation Process Framework
Expand Down
12 changes: 6 additions & 6 deletions specification/3___overview.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[#sec-overviewofssptraceability]
== Overview of SSP Traceability

As improving traceability of design decisions and simulations is one the core objectives of the SSP Traceability specification, a consistent and compatible documentation of decision processes and the simulation processes that produce decision-relevant simulation results is essential.
As improving traceability of design decisions and simulations is one the core objectives of the SSP Layered Standard Traceability, a consistent and compatible documentation of decision processes and the simulation processes that produce decision-relevant simulation results is essential.

[#sec-glueparticle]
=== GlueParticle Approach

To enable the documentation of process-relevant information and resources for a Credible Decision Process or a Credible Simulation Process the SSP Traceability Specification introduces the GlueParticle Approach:
To enable the documentation of process-relevant information and resources for a Credible Decision Process or a Credible Simulation Process the SSP Layered Standard Traceability introduces the GlueParticle Approach:

* The **GlueParticle Approach** is a concept for bundling and file-based transfer of process-relevant information and resources of a Credible Decision Process or a Credible Simulation Process.

Expand All @@ -17,20 +17,20 @@ The form in which this bundle exists, e.g. whether it is stored as a file or in

* File-based resources linked by a GlueParticle file should be exchanged with the GlueParticle file itself to **take full advantage** of the GlueParticle transfer.

NOTE: Although the idea of the GlueParticle approach does not depend on a specific data format or representation in general, the SSP Traceability Specification defines a set of data formats for the file-based representation of a GlueParticle content, i.e. process-relevant information and resources.
NOTE: Although the idea of the GlueParticle approach does not depend on a specific data format or representation in general, the SSP Layered Standard Traceability defines a set of data formats for the file-based representation of a GlueParticle content, i.e. process-relevant information and resources.
The reason for this is firstly that the Modelica Association uses XML as a general encoding format for the representation of standards specific data and secondly that SSP Traceability uses System Structure and Parameterization (SSP) Standard 2.0 resources and concepts that are also encoded in XML.
Independently of this, SSP Traceability files in general and GlueParticle files in particular could use any other applicable data encoding format, e.g. JSON etc.

The SSP Traceability specification specifies a set of data formats that can be used to document or link process-relevant information and resources for a Credible Decision Process and a Credible Simulation Process introduced in <<sec-crediblesimulationprocessframework>>.
The SSP Layered Standard Traceability specifies a set of data formats that can be used to document or link process-relevant information and resources for a Credible Decision Process and a Credible Simulation Process introduced in <<sec-crediblesimulationprocessframework>>.
The data formats are specified as a set of XML Schema files according to the W3C (https://www.w3.org/) XML Schema standard <<XMLSCHEMA1.1>>.

The main data formats specified by this specification are:
The main data formats specified by this standard are:

D**ecision **T**ask **M**eta **D**ata **(DTMD):: XML format representing process-relevant information to the Credible Decision Process (see <<sec-dtmdintroduction>> for an introduction and <<sec-dtmd>> for the detailed specification).

S**imulation **T**ask **M**eta **D**ata **(STMD):: XML format representing process-relevant information to the Credible Simulation Process (see <<sec-stmdintroduction>> for an introduction and <<sec-stmd>> for the detailed specification).

A third XML format defined by the SSP Traceability specification is:
A third XML format defined by the SSP Layered Standard Traceability is:

S**imulation **R**esource **M**eta **D**ata **(SRMD):: XML format representing metadata for resources (see <<sec-srmdintroduction>> for an introduction and <<sec-srmd>> for the detailed specification).

Expand Down
Loading