diff --git a/docs/1___overview.adoc b/docs/1___overview.adoc index 8cff13c..f4aa9a4 100644 --- a/docs/1___overview.adoc +++ b/docs/1___overview.adoc @@ -25,7 +25,7 @@ It must be possible to answer questions such as: * Were the simulation objectives and credibility requirements fulfilled? -While the MIC Core specification provides metadata for simulation models, it does not describe the simulation tasks in which those models are used. +While the MIC Core specification provides metadata for simulation models, it does not support and describe the simulation tasks in which those models are used (see figure 1). This specification addresses this gap. @@ -94,7 +94,12 @@ The goal of this specification is therefore not to prescribe a fixed metadata im === Simulation Process Context -The metadata structure defined in this specification follows a simulation process aligned with the *Credible Simulation Process Framework.* +The metadata structure defined in this specification follows a simulation process aligned with the https://modelica.github.io/ssp-ls-traceability/1.0.0/#sec-crediblesimulationprocessframework[*Credible Simulation Process Framework*], as defined in <>, as referenced in the SSP Layered Standard Traceability 1.0.0 specification (see <>): + +[#im-csp] +.Credible Simulation Process with attached metadata to the process phases +image::CSP.png[] + This process distinguishes the following phases: @@ -143,6 +148,15 @@ This approach allows organizations to implement the standard incrementally and a Additionally, the specification is designed to be technology-agnostic, meaning that it does not prescribe specific data formats or technologies for metadata representation, or mapping of metadata items to specific attribute names in a specific format. +=== Sub-Attributes + +For a number of attributes, for example for <>, the specification allows the use of sub-attributes to describe the attribute in more detail, e.g. by providing both machine-readable and human-readable variants of a name, version information, or URIs. + +The use of sub-attributes is per-se optional, however standards implementing this specification can make the use of sub-attributes, and the use of certain sub-attributes mandatory. + +The list of allowed sub-attributes is listed in the definition of an attribute. +Since they are shared between attribute definitions, the definition of common sub-attributes is placed in <>. + === Obligation Levels and Use-Case Dependency The attributes defined in this specification are categorized into three obligation levels: Mandatory, Recommended, and Optional. diff --git a/docs/2___core_attributes.adoc b/docs/2___core_attributes.adoc index 0758960..da41b82 100644 --- a/docs/2___core_attributes.adoc +++ b/docs/2___core_attributes.adoc @@ -1,11 +1,14 @@ -[[sic-core-attributes]] +[#sic-core-attributes] == SIC Core Attributes This chapter introduces and describes the list of SIC core attributes. Each attribute is introduced with an attribute description and an indication of the attribute obligation, i.e., whether the attribute is mandatory, recommended, or optional, and whether the attribute can be instantiated multiple times or not. To enhance the understanding of an attribute, some value examples and, if applicable, additional explanations or rationales for the attribute are provided. -The attributes are organized by the following attribute groups: +In <> a subset of the full set of SIC Core attributes is defined that enables basic functionality for search, analysis, reuse, and traceability. +This subset of metadata can also be used as starting point in the implementation of metadata for simulation. + +The attributes of SIC Core are organized by the following attribute groups: * Administrative Data @@ -27,72 +30,111 @@ The attributes are organized by the following attribute groups: The Administrative Data category contains information used to identify and organize the simulation. -==== Specific Product Name +==== Overall Product -Attribute description:: The _Specific Product Name_ is the unique master name of the specific product within the company's project management IT infrastructure, whose development or validation requires the respective simulation. +The _Overall Product_ is the overall product within the company's project management IT infrastructure, whose development or validation requires the respective simulation. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: No +Can have multiple values:: Yes + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> Value entry examples:: -* AD-34basic +* carZZ, aeroplaneTT -Additional explanation and rationale:: Providing the _Specific Product Name_ attribute makes it easier to track and trace the impact of a simulation result on the specific product for which the simulation is initially being requested. +Additional explanation and rationale:: Providing the _Overall Product_ attribute makes it easier to track and trace the impact of a simulation result on the overall product for which the simulation is initially being requested and executed. "Overall product" can also refer to a customer's product if a company develops and simulates a relevant product as a system or component specifically for a customer product. -==== Ordering Project Name +==== Specific Product -Attribute description:: The _Ordering Project Name_ is the unique master name of the ordering development project within the company's project management IT infrastructure. +Attribute description:: The _Specific Product_ is the specific product within the company's project management IT infrastructure, whose development or validation requires the respective simulation. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: No +Can have multiple values:: Yes + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> Value entry examples:: -* cam34basic +* AD-34basic -Additional explanation and rationale:: Providing the _Ordering Project Name_ attribute makes it easier to track and trace the simulation task and the simulation request back to the ordering development project and its engineering context. +Additional explanation and rationale:: Providing the _Specific Product_ attribute makes it easier to track and trace the impact of a simulation result on the specific product for which the simulation is initially being requested. -==== Simulation Request Name +==== Ordering Project -Attribute description:: The _Simulation Request Name_ is the unique name of the simulation request within the company's project management IT infrastructure. +Attribute description:: The _Ordering Project_ is the ordering development project within the company's project management IT infrastructure. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: No +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Request Name_ attribute makes it easier to trace back to the simulation request when it is referenced in a simulation task or simulation delivery, for example. +* cam34basic -==== Simulation Task Name +Additional explanation and rationale:: Providing the _Ordering Project_ attribute makes it easier to track and trace the simulation task and the simulation request back to the ordering development project and its engineering context. -Attribute description:: The _Simulation Task Name_ is the unique name of the simulation task within the originating company's project management IT infrastructure. +==== Simulation Request -Obligation:: Mandatory +Attribute description:: The _Simulation Request_ is the simulation request within the company's project management IT infrastructure. + +Obligation:: Recommended Can have multiple values:: No +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Task Name_ attribute makes it easier to trace back to the simulation task when it is referenced in a simulation delivery. +Additional explanation and rationale:: Providing the _Simulation Request_ attribute makes it easier to trace back to the simulation request when it is referenced in a simulation task or simulation delivery, for example. -==== Overall Product Name +==== Simulation Task -Attribute description:: The _Overall Product Name_ is the unique master name of the overall product within the company's project management IT infrastructure, whose development or validation requires the respective simulation. +Attribute description:: The _Simulation Task_ is the simulation task within the originating company's project management IT infrastructure. -Obligation:: Recommended +Obligation:: Mandatory -Can have multiple values:: Yes +Can have multiple values:: No -Value entry examples:: +Sub-attributes:: -* carZZ -* aeroplaneTT +* <> +* <> +* <> +* <> +* <> + +Value entry examples:: -Additional explanation and rationale:: Providing the _Overall Product Name_ attribute makes it easier to track and trace the impact of a simulation result on the overall product for which the simulation is initially being requested and executed. "Overall product" can also refer to a customer's product if a company develops and simulates a relevant product as a system or component specifically for a customer product. +Additional explanation and rationale:: Providing the _Simulation Task_ attribute makes it easier to trace back to the simulation task when it is referenced in a simulation delivery. ==== Simulation Task Confidentiality Level @@ -209,52 +251,76 @@ Additional explanation and rationale:: The _Simulation Task Creation Date_ attri === Analysis -==== Name of Item under Test +==== Item under Test -Attribute description:: The _Name of Item under Test_ specifies the product, system, component, or software, etc. that is subject of a simulation being requested by a simulation request or performed by a simulation task. +Attribute description:: The _Item under Test_ specifies the product, system, component, or software, etc. that is subject of a simulation being requested by a simulation request or performed by a simulation task. Obligation:: Mandatory -Can have multiple values:: Yes +Can have multiple values:: No + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> Value entry examples:: * camera34 * camera34-A-sampleV23 -Additional explanation and rationale:: Providing the _Name of Item under Test_ attribute helps clarifying the subject of simulation. +Additional explanation and rationale:: Providing the _Item under Test_ attribute helps clarifying the subject of simulation. -==== Simulation Objective +==== Higher-level Engineering Task -Attribute description:: The _Simulation Objective_ represents the engineering question that is to be answered by the simulation task. +Attribute description:: The _Higher-level Engineering Task_ is a higher-level engineering task that sets the context of the specific engineering task. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> Value entry examples:: -* assessment of the camera resolution by simulation +* Development of an AD driving function based on camera signals -Additional explanation and rationale:: Providing the _Simulation Objective_ attribute helps keep the focus on the target and to ensures that the entire simulation task is streamlined to the target. +Additional explanation and rationale:: The _Higher-level Engineering Task_ attribute in combination with the _Specific Engineering Task_ attribute supports understanding the context in witch the simulation is placed. -==== Simulation further Requirements +==== Specific Engineering Task -Attribute description:: The _Simulation further Requirements_ define what is to be determined, confirmed, or neglected by a simulation. +Attribute description:: The _Specific Engineering Task_ is the engineering task that directly benefits from the simulation results. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> Value entry examples:: -* the distance between vehicle and pedestrian must be higher than 1.5m +* Detection of critical occlusions when turning right with pedestrians. -Additional explanation and rationale:: Providing the Simulation further requirement attribute is an important input for the development of the test cases of a simulation. Often detailed information is linked. +Additional explanation and rationale:: The _Specific Engineering Task_ attribute in combination with the _Higher-level Engineering Task_ attribute supports understanding the context in witch the simulation is placed. -==== Quality Criterion +==== Simulation Objective -Attribute description:: A _Quality Criterion_ is a quality requirement that must be met during the simulation, particularly given the importance of the decision to be made. +Attribute description:: The _Simulation Objective_ represents the engineering question that is to be answered by the simulation task. Obligation:: Mandatory @@ -262,37 +328,37 @@ Can have multiple values:: Yes Value entry examples:: -* companyZ simulation quality assessment +* assessment of the camera resolution by simulation -Additional explanation and rationale:: The _Quality Criterion_ attribute facilitate the configuration of the simulation setup. +Additional explanation and rationale:: Providing the _Simulation Objective_ attribute helps keep the focus on the target and to ensures that the entire simulation task is streamlined to the target. -==== Higher Level Engineering Task +==== Further Simulation Requirements -Attribute description:: The _Higher Level Engineering Task_ is a _Higher Level Engineering Task_ that sets the context of the _Specific Engineering Task_. +Attribute description:: The _Further Simulation Requirements_ define what is to be determined, confirmed, or neglected by a simulation. Obligation:: Recommended -Can have multiple values:: No +Can have multiple values:: Yes Value entry examples:: -* development of an AD driving function based on camera signals +* the distance between vehicle and pedestrian must be higher than 1.5m -Additional explanation and rationale:: The _Higher Level Engineering Task_ attribute in combination with the _Specific Engineering Task_ attribute supports understanding the context in which the simulation is placed. +Additional explanation and rationale:: Providing the _Further Simulation Requirements_ attribute is an important input for the development of the test cases of a simulation. Often detailed information is linked. -==== Specific Engineering Task +==== Quality Criterion -Attribute description:: The _Specific Engineering Task_ is the engineering that directly benefits from the simulation results. +Attribute description:: A _Quality Criterion_ is a quality requirement that must be met during the simulation, particularly given the importance of the decision to be made. Obligation:: Recommended -Can have multiple values:: No +Can have multiple values:: Yes Value entry examples:: -* detection of critical occlusions when turning right with pedestrians +* companyZ simulation quality assessment -Additional explanation and rationale:: The _Specific Engineering Task_ attribute in combination with the _Higher Level Engineering Task_ attribute supports understanding the context in which the simulation is placed. +Additional explanation and rationale:: The _Quality Criterion_ attribute facilitate the configuration of the simulation setup. ==== Verification Criterion @@ -336,7 +402,7 @@ Additional explanation and rationale:: The _Analysis Phase Verification Result_ Attribute description:: The _Model Purpose and Objectives_ are indicating, based on the simulation purpose and objectives, individual _Model Purpose and Objectives_. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: Yes @@ -350,87 +416,99 @@ Additional explanation and rationale:: The _Model Purpose and Objectives_ attrib Attribute description:: The _Modeled Entity_ is the real-world entity that is to be modeled. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: Yes +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: * camera34-A-sampleV23 Additional explanation and rationale:: Providing the _Modeled Entity_ attribute enables specification of individual simulation models and parameters. This could not only comprise the item under test, but all additional entities modeled needed to conduct the simulation. -==== Entity Parameter -Attribute description:: The _Entity Parameter_ reference provided parameters of the entity to be modeled. +==== Required Modeled Effect -Obligation:: Mandatory +Attribute description:: The _Required Modeled Effect_ is a real-world physical effect that is to be considered in the modeling. + +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -* data sheet of camera -* material database +* resolution of camera -Additional explanation and rationale:: Providing the _Entity parameter_ attribute is essential input information for the parameterization. +Additional explanation and rationale:: The _Required Modeled Effect_ is a real-world physical effect that should be considered in modeling. -==== Simulation Environment Requirement +==== Further Model Requirements -Attribute description:: A _Simulation Environment Requirement_ is a requirement placed on the simulation environment. +Attribute description:: The _Further Model Requirements_ is additional requirements placed on a model, including things that explicitly shall / are not be considered in the model. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -* tool for causal modeling and simulation and supporting FMI -* FEM - -Additional explanation and rationale:: Providing the _Simulation Environment Requirement_ attribute helps specify the required simulation environment. +Additional explanation and rationale:: The _Further Model Requirements_ shall be considered in the same liability as the required modeled effects. This may not yet be available at the start of the simulation task. The attribute could therefore be omitted. It should be present once the simulation task has been completed. -==== Simulation Integration Requirement +==== Simulation Model Confidentiality Level -Attribute description:: A _Simulation Integration Requirement_ is a requirement placed on the interaction of the simulation setup elements. +Attribute description:: The _Simulation Model Confidentiality Level_ is a classification with respect to the access to classified information. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Integration Requirement_ attribute helps specify the required simulation integration, i.e. to specify how all elements of the simulation setup should interact. +* CSC-0: public +* CSC-1: internal +* CSC-2: confidential +* CSC-3: strictly confidential -==== Test Case Requirements +Additional explanation and rationale:: The _Simulation Model Confidentiality Level_ attribute uses a classification system that specifies how confidential the information contained in the classified document is to be treated. Typically, there is a set of rules that specifies what may and may not be done with a document and the information it contains. -Attribute description:: The _Test Case Requirements_ is the description of the goals and objectives of a test case. +==== Model Quality Requirement -Obligation:: Mandatory +Attribute description:: A _Model Quality Requirement_ is a requirement placed on a simulation model. + +Obligation:: Optional Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Test Case Requirements_ attribute helps specify the implementation of test cases. +Additional explanation and rationale:: Providing the _Model Quality Requirement_ attribute helps specify the implementation of simulation models. -==== Required Modeled Effect +==== Entity Parameter -Attribute description:: The _Required Modeled Effect_ is a real-world physical effect that is to be considered in the modeling. +Attribute description:: The _Entity Parameter_ reference provided parameters of the entity to be modeled. -Obligation:: Recommended +Obligation:: Mandatory Can have multiple values:: Yes Value entry examples:: -* resolution of camera +* data sheet of camera +* material database -Additional explanation and rationale:: The _Required Modeled Effect_ is a real-world physical effect that should be considered in modeling. +Additional explanation and rationale:: Providing the _Entity Parameter_ attribute is essential input information for the parameterization. -==== Further Model Requirements -Attribute description:: The _Further Model Requirements_ is additional requirements placed on a model, including things that explicitly shall / are not be considered in the model. +==== Value Distribution Function + +Attribute description:: The _Value Distribution Function_ (value deviation) specifies the probability of deviations certain value. Obligation:: Recommended @@ -438,11 +516,11 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: The _Further Model Requirements_ shall be considered in the same liability as the required modeled effects. This may not yet be available at the start of the simulation task. The attribute could therefore be omitted. It should be present once the simulation task has been completed. +Additional explanation and rationale:: The _Value Distribution Function_ attribute serves for ensuring that the simulation results are robust against little value deviation in a real world situation (required tolerances uncertainties). -==== Simulation Model Confidentiality Level +==== Parameter Confidentiality Level -Attribute description:: The _Simulation Model Confidentiality Level_ is a classification with respect to the access to classified information. +Attribute description:: The _Parameter Confidentiality Level_ is a classification with respect to the access to classified information. Obligation:: Recommended @@ -455,11 +533,23 @@ Value entry examples:: * CSC-2: confidential * CSC-3: strictly confidential -Additional explanation and rationale:: The _Simulation Model Confidentiality Level_ attribute uses a classification system that specifies how confidential the information contained in the classified document is to be treated. Typically, there is a set of rules that specifies what may and may not be done with a document and the information it contains. +Additional explanation and rationale:: The _Parameter Confidentiality Level_ attribute uses a classification system that specifies how confidential the information contained in the classified document is to be treated. Typically, there is a set of rules that specifies what may and may not be done with a document and the information it contains. -==== Value Distribution Function +==== Parameter Quality Requirement -Attribute description:: The _Value Distribution Function_ (value deviation) specifies the probability of deviations certain value. +Attribute description:: A Parameter quality requirement is a requirement placed on (a set of) parameters. + +Obligation:: Optional + +Can have multiple values:: Yes + +Value entry examples:: + +Additional explanation and rationale:: Providing the Parameter quality requirements in requieremts phase attribute helps specify the implentation of parameters. Quality requirements can be also part of general requirements + +==== Test Case Requirements + +Attribute description:: The _Test Case Requirements_ is the description of the goals and objectives of a test case. Obligation:: Recommended @@ -467,11 +557,11 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: The _Value Distribution Function_ attribute serves for ensuring that the simulation results are robust against little value deviation in a real world situation (required tolerances uncertainties). +Additional explanation and rationale:: Providing the _Test Case Requirements_ attribute helps specify the implementation of test cases. -==== Parameter Confidentiality Level +==== Test Case Confidentiality Level -Attribute description:: The _Parameter Confidentiality Level_ is a classification with respect to the access to classified information. +Attribute description:: The _Test Case Confidentiality Level_ is a classification with respect to the access to classified information. Obligation:: Recommended @@ -486,33 +576,36 @@ Value entry examples:: Additional explanation and rationale:: The _Parameter Confidentiality Level_ attribute uses a classification system that specifies how confidential the information contained in the classified document is to be treated. Typically, there is a set of rules that specifies what may and may not be done with a document and the information it contains. -==== Quality Assurance Requirements +==== Test Case Quality Requirement -Attribute description:: A _Quality Assurance Requirements_ is a requirements that is placed on the quality assurance in the requirements phase. +Attribute description:: A Test case quality requirement is a requirement that is placed on a test case. -Obligation:: Recommended +Obligation:: Optional Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Quality Assurance Requirements_ attribute helps understand the quality assurance measures made in the requirements phase. The attribute contains the derivation or decomposition of the quality criteria specified in the objectives section. +Additional explanation and rationale:: Providing the Test case requirements attribute helps specify the implementation of test cases. Quality requirements can be also part of general requirements -==== Requirements Phase Verification Result +==== Simulation Environment Requirement -Attribute description:: The _Requirements Verification Result_ is the result of the verification activity in the requirements phase. +Attribute description:: A _Simulation Environment Requirement_ is a requirement placed on the simulation environment. Obligation:: Recommended -Can have multiple values:: No +Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing a _Requirements Verification Result_ attribute helps recognize the quality status of the requirements phase results. This attribute can contain a link to a verification report. +* tool for causal modeling and simulation and supporting FMI +* FEM -==== Model Quality Requirement +Additional explanation and rationale:: Providing the _Simulation Environment Requirement_ attribute helps specify the required simulation environment. -Attribute description:: A _Model Quality Requirement_ is a requirement placed on a simulation model. +==== Simulation Environment Quality Requirement + +Attribute description:: A Simulation environment quality requirement is a requirement placed on the simulation environment. Obligation:: Optional @@ -520,23 +613,24 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Model Quality Requirement_ attribute helps specify the implementation of simulation models. +Additional explanation and rationale:: Providing the Simulation environment quality requirement attribute helps specify the required simulation environment. Quality requirements can be also part of general requirements -==== Parameter Quality Requirement -Attribute description:: A _Parameter Quality Requirement_ is a requirement placed on (a set of) parameters. +==== Simulation Integration Requirement -Obligation:: Optional +Attribute description:: A _Simulation Integration Requirement_ is a requirement placed on the interaction of the simulation setup elements. + +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Parameter Quality requirements_ in requirements phase attribute helps specify the implementation of parameters. +Additional explanation and rationale:: Providing the _Simulation Integration Requirement_ attribute helps specify the required simulation integration, i.e. to specify how all elements of the simulation setup should interact. -==== Simulation Environment Quality Requirement +==== Simulation Integration Quality Requirement -Attribute description:: A _Simulation Environment Quality Requirement_ is a requirement placed on the simulation environment. +Attribute description:: A Simulation integration quality requirement is a requirement that is placed on the simulation integration. Obligation:: Optional @@ -544,31 +638,36 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Environment Quality Requirement_ attribute helps specify the required simulation environment. +Additional explanation and rationale:: Providing the Simulation integration quality requirement attribute helps specify the needed simulation integration, i.e., specify how all elements of the simulation setup shall interact. +Quality requirements can be also part of general requirements -==== Simulation Integration Quality Requirement -Attribute description:: A _Simulation Integration Quality Requirement_ is a requirement that is placed on the simulation integration. -Obligation:: Optional +==== Quality Assurance Requirements + +Attribute description:: A _Quality Assurance Requirements_ is a requirements that is placed on the quality assurance in the requirements phase. + +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Integration Quality Requirement_ attribute helps specify the needed simulation integration, i.e., specify how all elements of the simulation setup shall interact. +Additional explanation and rationale:: Providing the _Quality Assurance Requirements_ attribute helps understand the quality assurance measures made in the requirements phase. The attribute contains the derivation or decomposition of the quality criteria specified in the objectives section. -==== Test Case Quality Requirement +==== Requirements Phase Verification Result -Attribute description:: A _Test Case Quality Requirement_ is a requirement that is placed on a test case. +Attribute description:: The _Requirements Verification Result_ is the result of the verification activity in the requirements phase. -Obligation:: Optional +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No Value entry examples:: -Additional explanation and rationale:: Providing _Test Case Quality Requirement_ attribute helps specify the implementation of test cases. +Additional explanation and rationale:: Providing a _Requirements Verification Result_ attribute helps recognize the quality status of the requirements phase results. This attribute can contain a link to a verification report. + + === Design @@ -584,25 +683,22 @@ Value entry examples:: Additional explanation and rationale:: The _Model Design Specification_ attribute provides the base for the model implementation. Typically, the attribute contains a link to the appropriate document or the model name and version which should be used. -==== Parameter Design Specification +==== Model Design Quality Requirement -Attribute description:: A _Parameter Design Specification_ is the definition of how parameters are to be implemented, including parameter structures, names, values, tolerances, etc. +Attribute description:: A _Model Quality Requirement_ is a requirement that is placed on a simulation model. -Obligation:: Recommended +Obligation:: Optional Can have multiple values:: Yes Value entry examples:: -* format test environment -* links to data sheets, measurements, material data -* specifications on handling tolerances uncertainties +Additional explanation and rationale:: Providing the _Model Design Quality Requirement_ helps to implement simulation models with appropriate and sufficient quality. -Additional explanation and rationale:: The _Parameter Design Specification_ attribute provides the base for the (set of) parameters implementation. Typically, the attribute contains a link to the appropriate document or the Parameter Name and version which should be used. -==== Simulation Environment Design Specification +==== Parameter Design Specification -Attribute description:: A _Simulation Environment Design Specification_ is the definition of how simulation environment is to be implemented or which tool and version should be used. +Attribute description:: A _Parameter Design Specification_ is the definition of how parameters are to be implemented, including parameter structures, names, values, tolerances, etc. Obligation:: Recommended @@ -610,19 +706,24 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: The _Simulation Environment Design Specification_ attribute provides the base for the Simulation environment implementation. Typically the attribute contains a link to the appropriate document or the tool name and version which should be used. +* format test environment +* links to data sheets, measurements, material data +* specifications on handling tolerances uncertainties -==== Simulation Integration Design Specification +Additional explanation and rationale:: The _Parameter Design Specification_ attribute provides the base for the (set of) parameters implementation. Typically, the attribute contains a link to the appropriate document or the Parameter Name and version which should be used. -Attribute description:: A _Simulation Integration Design Specification_ is the definition of how simulation components are to be integrated. -Obligation:: Recommended +==== Parameter Design Quality Requirement -Can have multiple values:: No +Attribute description:: A _Parameter Design Quality Requirement_ is a requirement that is placed on (a set of) parameters. + +Obligation:: Optional + +Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: The _Simulation Integration Design Specification_ attribute provides the base for the Simulation integration implementation. Typically the attribute contains a link to the appropriate document. +Additional explanation and rationale:: Providing the _Parameter Design Quality Requirement_ attribute helps to implement the (set of) parameters with appropriate and sufficient quality. ==== Test Case Design Specification @@ -640,53 +741,32 @@ Value entry examples:: Additional explanation and rationale:: The _Test Case Design Specification_ are the base for test cases. -==== Design Quality Assurance +==== Test Case Design Quality Requirement -Attribute description:: A _Design Phase Quality Assurance_ describe a quality assurance measure in the design phase. +Attribute description:: A _Test Case Design Quality Requirement_ is a requirement that is placed on a test cases. -Obligation:: Recommended +Obligation:: Optional Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Design Phase Quality Assurance_ helps understanding the quality assurance measures made in the design phase. - -==== Design Verification Result - -Attribute description:: The _Design Verification Result_ is the result of the verification activity in the design phase. - -Obligation:: Recommended - -Can have multiple values:: No - -Value entry examples:: +Additional explanation and rationale:: Providing the _Test Case Design Quality Requirement_ helps to implement test cases with appropriate and sufficient quality. -Additional explanation and rationale:: Providing the _Design Verification Result_ helps to recognize the quality status of the requirements phase results. This attribute can contain a link to a verification report. -==== Model Design Quality Requirement +==== Simulation Environment Design Specification -Attribute description:: A _Model Quality Requirement_ is a requirement that is placed on a simulation model. +Attribute description:: A _Simulation Environment Design Specification_ is the definition of how simulation environment is to be implemented or which tool and version should be used. -Obligation:: Optional +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Model Design Quality Requirement_ helps to implement simulation models with appropriate and sufficient quality. - -==== Parameter Design Quality Requirement - -Attribute description:: A _Parameter Design Quality Requirement_ is a requirement that is placed on (a set of) parameters. +Additional explanation and rationale:: The _Simulation Environment Design Specification_ attribute provides the base for the Simulation environment implementation. Typically the attribute contains a link to the appropriate document or the tool name and version which should be used. -Obligation:: Optional -Can have multiple values:: Yes - -Value entry examples:: - -Additional explanation and rationale:: Providing the _Parameter Design Quality Requirement_ attribute helps to implement the (set of) parameters with appropriate and sufficient quality. ==== Simulation Environment Design Quality Requirement @@ -700,21 +780,22 @@ Value entry examples:: Additional explanation and rationale:: Providing the _Simulation Environment Design Quality Requirement_ attribute helps to implement the simulation environment with appropriate and sufficient quality or the chosen tool has to fulfill. -==== Simulation Integration Design Quality Requirement +==== Simulation Integration Design Specification -Attribute description:: A _Simulation Integration Design Quality Requirement_ is a requirement that is placed on a simulation environment. +Attribute description:: A _Simulation Integration Design Specification_ is the definition of how simulation components are to be integrated. -Obligation:: Optional +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Integration Design Quality Requirement_ attribute helps to implement the simulation environment with appropriate and sufficient quality. This includes all interactions of simulation setup elements. +Additional explanation and rationale:: The _Simulation Integration Design Specification_ attribute provides the base for the Simulation integration implementation. Typically the attribute contains a link to the appropriate document. -==== Test Case Design Quality Requirement -Attribute description:: A _Test Case Design Quality Requirement_ is a requirement that is placed on a test cases. +==== Simulation Integration Design Quality Requirement + +Attribute description:: A _Simulation Integration Design Quality Requirement_ is a requirement that is placed on a simulation environment. Obligation:: Optional @@ -722,57 +803,57 @@ Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Test Case Design Quality Requirement_ helps to implement test cases with appropriate and sufficient quality. +Additional explanation and rationale:: Providing the _Simulation Integration Design Quality Requirement_ attribute helps to implement the simulation environment with appropriate and sufficient quality. This includes all interactions of simulation setup elements. -=== Implementation -==== Simulation Model Name -Attribute description:: The _Simulation Model Name_ is the given name for the implemented simulation model within the company's project management IT infrastructure. +==== Design Quality Assurance -Obligation:: Mandatory +Attribute description:: A _Design Phase Quality Assurance_ describe a quality assurance measure in the design phase. + +Obligation:: Recommended Can have multiple values:: Yes Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Model Name_ attribute makes it easier to track and trace the simulation models implemented. +Additional explanation and rationale:: Providing the _Design Phase Quality Assurance_ helps understanding the quality assurance measures made in the design phase. -==== Parameter Name +==== Design Verification Result -Attribute description:: The _Parameter Name_ is the given name for the implemented (set of) parameters within the company's project management IT infrastructure. +Attribute description:: The _Design Verification Result_ is the result of the verification activity in the design phase. -Obligation:: Mandatory +Obligation:: Recommended -Can have multiple values:: Yes +Can have multiple values:: No Value entry examples:: -Additional explanation and rationale:: Providing the _Parameter Name_ attribute makes it easier to track and trace the (set of) parameters implemented. - -==== Simulation Environment Name +Additional explanation and rationale:: Providing the _Design Verification Result_ helps to recognize the quality status of the requirements phase results. This attribute can contain a link to a verification report. -Attribute description:: The _Simulation Environment Name_ is the given name for the implemented simulation environment within the company's project management IT infrastructure. -Obligation:: Mandatory -Can have multiple values:: Yes +=== Implementation -Value entry examples:: +==== Simulation Model -Additional explanation and rationale:: Providing the _Simulation Environment Name_ attribute makes it easier to track and trace the simulation environment implemented. +Attribute description:: The _Simulation Model_ is the implemented simulation model within the company's project management IT infrastructure. -==== Simulation Integration Name +Obligation:: Recommended -Attribute description:: The _Simulation Integration Name_ is the given name for the implemented simulation integration within the company's project management IT infrastructure. +Can have multiple values:: Yes -Obligation:: Mandatory +Sub-attributes:: -Can have multiple values:: Yes +* <> +* <> +* <> +* <> +* <> Value entry examples:: -Additional explanation and rationale:: Providing the _Simulation Integration Name_ attribute makes it easier to track and trace the simulation integration implemented. +Additional explanation and rationale:: Providing the _Simulation Model_ attribute makes it easier to track and trace the simulation models implemented. ==== Simulation Model Confidentiality Level @@ -803,6 +884,27 @@ Value entry examples:: Additional explanation and rationale:: Providing the _Simulation Model Quality_ attribute helps to assess the quality of a model. +==== Parameter + +Attribute description:: The _Parameter_ is the implemented (set of) parameters within the company's project management IT infrastructure. + +Obligation:: Recommended + +Can have multiple values:: Yes + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + +Value entry examples:: + +Additional explanation and rationale:: Providing the _Parameter_ attribute makes it easier to track and trace the (set of) parameters implemented. + + ==== Parameter Confidentiality Level Attribute description:: The _Parameter Confidentiality Level_ is a classification with respect to the access to classified information. @@ -832,29 +934,25 @@ Value entry examples:: Additional explanation and rationale:: Providing the _Parameter Quality_ attribute helps to assess the quality of a parameter or a set of parameters. -==== Simulation Environment Quality +==== Test Case -Attribute description:: The _Simulation Environment Quality_ is a statement of any kind that describes the Simulation Environment Quality actually achieved by implementation. +Attribute description:: The _Test Case_ is the implemented test cases within the company's project management IT infrastructure. Obligation:: Recommended Can have multiple values:: Yes -Value entry examples:: +Sub-attributes:: -Additional explanation and rationale:: Providing the _Simulation Environment Quality_ attribute helps to assess the quality of a simulation environment. - -==== Test Case Name - -Attribute description:: The _Test Case Name_ is the given name for the implemented test cases within the company's project management IT infrastructure. - -Obligation:: Recommended - -Can have multiple values:: Yes +* <> +* <> +* <> +* <> +* <> Value entry examples:: -Additional explanation and rationale:: Providing the _Test Case Name_ attribute makes it easier to track and trace the test cases implemented. +Additional explanation and rationale:: Providing the _Test Case_ attribute makes it easier to track and trace the test cases implemented. ==== Test Case Confidentiality Level @@ -885,6 +983,38 @@ Value entry examples:: Additional explanation and rationale:: Providing the _Test Case Quality_ attribute helps to assess the quality of a test case. +==== Simulation Environment + +Attribute description:: The _Simulation Environment_ is the implemented simulation environment within the company's project management IT infrastructure. + +Obligation:: Recommended + +Can have multiple values:: Yes + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + +Value entry examples:: + +Additional explanation and rationale:: Providing the _Simulation Environment_ attribute makes it easier to track and trace the simulation environment implemented. + +==== Simulation Environment Quality + +Attribute description:: The _Simulation Environment Quality_ is a statement of any kind that describes the Simulation Environment Quality actually achieved by implementation. + +Obligation:: Recommended + +Can have multiple values:: Yes + +Value entry examples:: + +Additional explanation and rationale:: Providing the _Simulation Environment Quality_ attribute helps to assess the quality of a simulation environment. + ==== Solver Setting Attribute description:: A _Solver Setting_ is a specific parameter that control the behavior of simulation solver tools. @@ -897,6 +1027,28 @@ Value entry examples:: Additional explanation and rationale:: Providing the _Solver Setting_ attribute helps to complete the simulation setup with recommended settings to control the requested behavior of the solver tool. +==== Simulation Integration + +Attribute description:: The _Simulation Integration_ is the implemented simulation integration within the company's project management IT infrastructure. + +Obligation:: Recommended + +Can have multiple values:: Yes + +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + +Value entry examples:: + +Additional explanation and rationale:: Providing the _Simulation Integration_ attribute makes it easier to track and trace the simulation integration implemented. + + + ==== Simulation Integration Quality Attribute description:: The _Simulation Integration Quality_ is a statement of any kind that describes the Simulation Integration Quality actually achieved by implementation. @@ -935,53 +1087,85 @@ Additional explanation and rationale:: Providing the _Implementation Quality Ver === Execution -==== Used Simulation Model Name +==== Used Simulation Model -Attribute description:: The _Used Simulation Model Name_ is the given name of a simulation model actually used in simulation execution. +Attribute description:: The _Used Simulation Model_ is a simulation model actually used in simulation execution. Obligation:: Mandatory Can have multiple values:: Yes +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: Providing the _Used Simulation Model Name_ attribute makes it easier to track and trace the simulation model actually used in the simulation. +Additional explanation and rationale:: Providing the _Used Simulation Model_ attribute makes it easier to track and trace the simulation model actually used in the simulation. -==== Used Parameter Name +==== Used Parameter -Attribute description:: The _Used Parameter Name_ is the given name of a parameter or parameter set actually used in simulation execution. +Attribute description:: The _Used Parameter_ is a parameter or parameter set actually used in simulation execution. Obligation:: Mandatory Can have multiple values:: Yes +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: Providing the _Used Parameter Name_ attribute makes it easier to track and trace the simulation model actually used in the simulation. +Additional explanation and rationale:: Providing the _Used Parameter_ attribute makes it easier to track and trace the simulation model actually used in the simulation. -==== Used Test Case Name +==== Used Test Case -Attribute description:: The _Used Test Case Name_ is the given name of a test case actually used in simulation execution. +Attribute description:: The _Used Test Case_ is a test case actually used in simulation execution. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: Yes +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: The combination of _Used Test Case Name_ and _Used Test Case Version_ shall be unique. +Additional explanation and rationale:: The combination of _Used Test Case_ sub-attributes _Name_ and _Version_ shall be unique. -==== Used Tool Name +==== Used Tool -Attribute description:: The _Used Tool Name_ is the given name of a tool actually used in simulation execution. +Attribute description:: The _Used Tool_ is a tool actually used in simulation execution. Obligation:: Mandatory Can have multiple values:: Yes +Sub-attributes:: + +* <> +* <> +* <> +* <> +* <> + Value entry examples:: -Additional explanation and rationale:: The combination of _Used Tool Name_ and _Used Tool Version_ shall be unique. +Additional explanation and rationale:: The combination of _Used Tool_ sub-attributes _Name_ and _Version_ shall be unique. ==== Execution Raw Data @@ -1025,7 +1209,7 @@ Additional explanation and rationale:: The _Execution Log_ is usually consulted Attribute description:: The _Evaluation Results_ are the key results that emerges from the processing of the raw results. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: Yes @@ -1059,9 +1243,9 @@ Additional explanation and rationale:: Providing the _Evaluation Quality Verdict === Fulfillment -==== Objectives Fulfilled +==== Task Status -Attribute description:: The _Objectives Fulfilled_ attribute is the clear and unambiguous documentation of a objective fulfillment decision with a predefined set of applicable entries, that indicates whether the objectives linked with the simulation task are fulfilled or not or whether a statement of the objectives fulfillment is not possible. +Attribute description:: The _Task Status_ attribute is the final assessment of the entire simulation task. The attribute shows whether the task is still in progress, aborted, finished or checked out (possible in status in progress). Obligation:: Mandatory @@ -1069,44 +1253,46 @@ Can have multiple values:: No Value entry examples:: -* Yes: Objectives are fulfilled -* No: Objectives are not fulfilled -* No statement possible +* In Progress: In progress +* Checked out: in progress but checked out from data management system +* Aborted: simulation task is aborted +* Finished: Task is finished -Additional explanation and rationale:: The _Objective fulfillment_ attribute helps quickly recognize and assess the simulation results without having to inspect all the details of a simulation task. +Additional explanation and rationale:: The _Task Status_ attribute helps to quickly recognize the status of the simulation task. -==== Credibility Fulfilled -Attribute description:: The _Credibility Fulfilled_ attribute is the clear and unambiguous documentation of a credibility fulfillment decision with a predefined set of applicable entries, that indicates whether the simulation task fulfills credibility requirements or not or whether a statement of the credibility fulfillment is not possible. +==== Quality Fulfilled -Obligation:: Mandatory +The Quality fulfilled attribute is the clear and unambigious documentation of a quality fulfillment decision with a predifiened set of applicable entries, that indicates whether the simulation task fulfills quality requirements or not or whether a statement of the quality fulfillment ist not possible. + +Obligation:: Recommended Can have multiple values:: No Value entry examples:: -* Yes: Credibility sufficient. Statements about objectives are possible -* No: Credibility not sufficient e.g. tolerances of sim results, confidence intervals do not allow statements about objectives -* No statement possible: No specifications for credibility or no evaluation carried out +* Yes: Quality sufficient. Statements about objectives are possible +* No: Quality not sufficient e.g. tolerances of sim results, confidence intervals do not allow statements about objectives +* No statement possible: No specifications for Quality or no evaluation carried out -Additional explanation and rationale:: The _Credibility fulfillment_ attribute helps quickly recognize and assess the simulation credibility without having to inspect all the details of a simulation task. +Additional explanation and rationale:: The Quality fulfillment attribute helps quickly recognize and assess the simulation Quality without having to inspect all the details of a simulation task. Can for example be the result of a simulation credibility assessment -==== Task Status +==== Objectives Fulfilled -Attribute description:: The _Task Status_ attribute is the final assessment of the entire simulation task. The attribute shows whether the task is still in progress, aborted, finished or checked out (possible in status in progress). +Attribute description:: The _Objectives Fulfilled_ attribute is the clear and unambiguous documentation of a objective fulfillment decision with a predefined set of applicable entries, that indicates whether the objectives linked with the simulation task are fulfilled or not or whether a statement of the objectives fulfillment is not possible. -Obligation:: Mandatory +Obligation:: Recommended Can have multiple values:: No Value entry examples:: -* In Progress: In progress -* Checked out: in progress but checked out from data management system -* Aborted: simulation task is aborted -* Finished: Task is finished +* Yes: Objectives are fulfilled +* No: Objectives are not fulfilled +* No statement possible + +Additional explanation and rationale:: The _Objective Fulfillment_ attribute helps quickly recognize and assess the simulation results without having to inspect all the details of a simulation task. -Additional explanation and rationale:: The _Task status_ attribute helps to quickly recognize the status of the simulation task. ==== Fulfillment Evidence @@ -1131,3 +1317,78 @@ Can have multiple values:: No Value entry examples:: Additional explanation and rationale:: The _Date_ attribute is useful for evaluation. + +[#common-sub-attributes] +=== Common Sub-Attributes + +=== Composite attributes + +Where indicated in the attribute definition, attributes can be composite attributes, which means that they have a predefined internal structure with a defined set of sub-attributes. +The sub-attributes are listed in the attribute definition and are not separately listed in the main list of attributes. +The use of sub-attributes is optional, however standards implementing this specification can make the use of sub-attributes, and the use of certain sub-attributes mandatory. + +Example: + +The _Simulation Model_ attribute includes the following sub-attributes: + +* _Name_ + +* _Version_ + +* _Identifier_ + +* _URL_ + +* _Full Name_ + +Thus beside the attribute _Simulation Model_, the sub-attributes _Simulation Model Name_, _Simulation Model Version_, _Simulation Model Identifier_, _Simulation Model URL_, and _Simulation Model Full Name_ are defined as well, but only as sub-attributes of the attribute _Simulation Model_. + +The following sub-attributes are defined in this specification and can be used for any attribute where the use of these sub-attributes is allowed: + +[#sub-attr-name] +==== Sub-Attribute Name + +Attribute description:: The _Name_ sub-attribute is the unique name of the given attribute within the originating company's project management IT infrastructure. +Obligation:: if sub-attributes are used, the name sub-attribute is mandatory +Can have multiple values:: No +Value examples:: +* carZZ, aeroplaneTT +Additional explanation and rationale:: The _Name_ sub-attribute is essential information that helps to track and trace the given attribute within the company's project management IT infrastructure. + +[#sub-attr-version] +==== Sub-Attribute Version + +Attribute description:: The _Version_ sub-attribute is a human readable version designation for the given attribute. +Obligation:: if sub-attributes are used, the version sub-attribute is mandatory +Can have multiple values:: Yes +Value examples:: +Additional explanation and rationale:: The _Version_ sub-attribute is essential information that helps keep track of which version of the attribute is being referenced. + +[#sub-attr-identifier] +==== Sub-Attribute Identifier + +Attribute description:: The _Identifier_ sub-attribute is the unique master ID of the entity referred to by the given attribute within the company's project management IT infrastructure. +If the company has a versioning mechanism for the entities referred to by the attribute in the project management IT infrastructure, the version ID is included in the identifier so that the attribute can be referenced with version accuracy. +Obligation:: if sub-attributes are used, the identifier sub-attribute is mandatory +Can have multiple values:: Yes +Value examples:: +Additional explanation and rationale:: The (version accurate) _Identifier_ sub-attribute is essential information needed to facilitate automated traceability to the entity referred to by the given attribute within the company's project management IT infrastructure. + +[#sub-attr-url] +==== Sub-Attribute URL + +Attribute description:: The _URL_ sub-attribute is an alternate way to identify the entity referred to by the given attribute. +The same considerations as for the _Identifier_ sub-attribute apply here. +Obligation:: Optional +Can have multiple values:: Yes +Value examples:: +Additional explanation and rationale:: The same considerations as for the _Identifier_ sub-attribute apply here as well. + +[#sub-attr-full-name] +==== Sub-Attribute Full Name + +Attribute description:: The _Full Name_ sub-attribute is the commonly known name of the entity referred to by the given attribute. +Obligation:: Optional +Can have multiple values:: Yes +Value examples:: +Additional explanation and rationale:: Providing the _Full Name_ sub-attribute with potentially relevant details helps quickly understand the context of the entity referred to by the given attribute. diff --git a/docs/3___conformance.adoc b/docs/3___conformance.adoc index 9b20cd5..37ee0a2 100644 --- a/docs/3___conformance.adoc +++ b/docs/3___conformance.adoc @@ -1,4 +1,4 @@ -[[sic-core-conformance]] +[#sic-core-conformance] == Conformance This specification provides a set of standardized attributes, which other standards that define meta-data and meta-data formats can adopt by claiming conformance. diff --git a/docs/4___literature.adoc b/docs/4___literature.adoc index c4a1d29..dd07383 100644 --- a/docs/4___literature.adoc +++ b/docs/4___literature.adoc @@ -4,3 +4,5 @@ - [[[PW13]]] Preston-Werner, T. (2013): **Semantic Versioning 2.0.0**. https://semver.org/spec/v2.0.0.html - [[[RFC2119]]] Bradner, S. (1997): **Key words for use in RFCs to Indicate Requirement Levels**. IETF RFC 2119. https://www.rfc-editor.org/rfc/rfc2119 - [[[MIC]]] IRT SystemX (2020): **Model Identity Card - Toward a standard to characterize simulation models**. https://mic.irt-systemx.fr +- [[[CSP]]] prostep ivip (2025): **Credible Simulation Process Framework** in prostep ivip SmartSE Recommendation 2025 PSI 11 V4.0 Part H: https://www.prostep.org/en/medialibrary/detail?ai%5Baction%5D=detail&ai%5Bcontroller%5D=Catalog&ai%5Bd_name%5D=prostep-ivip-smartse-recommendation-2025-psi-11-v-4-0-part-h-credible-simulation-process&ai%5Bd_pos%5D=2 +- [[[SSPLST]]] Modelica Association Project SSP (2025): **SSP Layered Standard Traceability 1.0.0**. https://ssp-standard.org/ssp-ls-traceability/1.0.0/ \ No newline at end of file diff --git a/docs/A___mapping_srmd.adoc b/docs/A___mapping_srmd.adoc index 0332499..f64e821 100644 --- a/docs/A___mapping_srmd.adoc +++ b/docs/A___mapping_srmd.adoc @@ -34,11 +34,11 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Specific Product Name | administrative.specific-product.name | Mandatory | Unique master name of the specific product whose development or validation requires the simulation. -| Ordering Project Name | administrative.ordering-project.name | Mandatory | Unique master name of the ordering development project. -| Simulation Request Name | administrative.simulation-request.name | Mandatory | Unique name of the simulation request. -| Simulation Task Name | administrative.simulation-task.name | Mandatory | Unique name of the simulation task. | Overall Product Name | administrative.overall-product.name | Recommended | Unique master name of the overall product associated with the simulation. +| Specific Product Name | administrative.specific-product.name | Recommended | Unique master name of the specific product whose development or validation requires the simulation. +| Ordering Project Name | administrative.ordering-project.name | Recommended | Unique master name of the ordering development project. +| Simulation Request Name | administrative.simulation-request.name | Recommended | Unique name of the simulation request. +| Simulation Task Name | administrative.simulation-task.name | Mandatory | Unique name of the simulation task. | Simulation Task Confidentiality Level | administrative.simulation-task.confidentiality | Recommended | Classification level that defines access to the contained information. | Predicted Simulation Start Date | administrative.simulation-task.date.start | Recommended | Date when all required information is expected to be available to start simulation. | Requested Simulation Delivery Date | administrative.simulation-task.date.delivery | Recommended | Date when simulation results are requested by the ordering side. @@ -56,11 +56,11 @@ Note that the abbreviated explanations are not considered a normative part of th |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation | Name of Item under Test | analysis.item-under-test.name | Mandatory | Product, system, component, software, or other item that is subject to simulation. -| Simulation Objective | analysis.simulation-task.objectives | Mandatory | Engineering question to be answered by the simulation task. -| Simulation further Requirements | analysis.simulation-task.further-requirements | Mandatory | Additional simulation requirements defining what to determine, confirm, or neglect. -| Quality Criterion | analysis.quality-aspects | Mandatory | Quality requirement to be fulfilled during simulation. | Higher Level Engineering Task | analysis.engineering-task.higher-level | Recommended | Higher-level engineering task that gives context for the specific task. | Specific Engineering Task | analysis.engineering-task.specific | Recommended | Concrete engineering task that directly benefits from simulation results. +| Simulation Objective | analysis.simulation-task.objectives | Mandatory | Engineering question to be answered by the simulation task. +| Simulation further Requirements | analysis.simulation-task.further-requirements | Recommended | Additional simulation requirements defining what to determine, confirm, or neglect. +| Quality Criterion | analysis.quality-aspects | Recommended | Quality requirement to be fulfilled during simulation. | Verification Criterion | analysis.verification | Recommended | Quality requirement for verifying alignment with simulation objectives. | Validation Criterion | analysis.validation | Recommended | Quality requirement for validating alignment with requesting engineering needs. | Analysis Phase Verification Result | analysis.verification | Recommended | Result of the analysis phase closing verification. @@ -71,24 +71,25 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Model Purpose and Objectives | requirements.models.purpose-objectives | Mandatory | Individual model purposes and objectives derived from simulation objectives. -| Modeled Entity | requirements.models.subject-information.modeled-entity | Mandatory | Real-world entity that is to be modeled. -| Entity Parameter | requirements.parameters.subject-information.parametrized-entity | Mandatory | Referenced parameters of the entity to be modeled. -| Simulation Environment Requirement | requirements.simulation-environment | Mandatory | Requirement placed on the simulation environment. -| Simulation Integration Requirement | requirements.simulation-integration | Mandatory | Requirement placed on interaction of simulation setup elements. -| Test Case Requirements | requirements.test-cases | Mandatory | Requirements for simulation test cases and their objectives. -| Required Modeled Effect | requirements.models.effects-considered | Recommended | Real-world physical effect that shall be considered in modeling. -| Further Model Requirements | requirements.models.further-model-requirements | Recommended | Additional requirements placed on the model. +| Model Purpose and Objectives | requirements.models.purpose-objectives | Recommended | Individual model purposes and objectives derived from simulation objectives. +| Modeled Entity | requirements.models.subject-information.modeled-entity | Recommended | Real-world entity that is to be modeled. +| Required Modeled Effect | requirements.model.effects-considered | Recommended | Real-world physical effect that shall be considered in modeling. +| Further Model Requirements | requirements.model.further-model-requirements | Recommended | Additional requirements placed on the model. | Simulation Model Confidentiality Level | requirements.model.confidentiality | Recommended | Confidentiality classification for model-related information. -| Value Distribution Function | requirements.parameters-value-distribution-function | Recommended | Probability distribution used to describe parameter value deviations. +| Model Quality Requirement | requirements.model.quality-requirements | Optional | Quality requirement for a simulation model. +| Entity Parameter | requirements.parameters.subject-information.parametrized-entity | Mandatory | Referenced parameters of the entity to be modeled. +| Value Distribution Function | requirements.parameter-value-distribution-function | Recommended | Probability distribution used to describe parameter value deviations. | Parameter Confidentiality Level | requirements.parameter.confidentiality | Recommended | Confidentiality classification for parameter-related information. -| Quality Assurance Requirements | requirements.quality-assurance | Recommended | Requirements placed on quality assurance in the requirements phase. -| Requirements Phase Verification Result | requirements.verification | Recommended | Result of verification activities in the requirements phase. -| Model Quality Requirement | requirements.models.quality-requirements | Optional | Quality requirement for a simulation model. -| Parameter Quality Requirement | requirements.parameters.quality-requirements | Optional | Quality requirement for parameter sets. +| Parameter Quality Requirement | requirements.parameter.quality-requirements | Optional | Quality requirement for parameter sets. +| Test Case Requirements | requirements.test-case | Recommended | Requirements for simulation test cases and their objectives. +| Test Case Confidentiality Level | requirements.test-case.confidentiality | Recommended | Confidentiality classification for parameter-related information. +| Test Case Quality Requirement | requirements.test-case.quality-requirements | Optional | Quality requirement for test cases. +| Simulation Environment Requirement | requirements.simulation-environment | Recommended | Requirement placed on the simulation environment. | Simulation Environment Quality Requirement | requirements.simulation-environment.quality-requirements | Optional | Quality requirement for the simulation environment. +| Simulation Integration Requirement | requirements.simulation-integration | Recommended | Requirement placed on interaction of simulation setup elements. | Simulation Integration Quality Requirement | requirements.simulation-integration.quality-requirements | Optional | Quality requirement for simulation integration. -| Test Case Quality Requirement | requirements.test-cases.quality-requirements | Optional | Quality requirement for test cases. +| Quality Assurance Requirements | requirements.quality-assurance | Recommended | Requirements placed on quality assurance in the requirements phase. +| Requirements Phase Verification Result | requirements.verification | Recommended | Result of verification activities in the requirements phase. |=== ==== Design @@ -96,18 +97,18 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Model Design Specification | design.models | Recommended | Definition of how models shall be implemented. -| Parameter Design Specification | design.parameters | Recommended | Definition of how parameters shall be implemented. +| Model Design Specification | design.model | Recommended | Definition of how models shall be implemented. +| Model Design Quality Requirement | design.model.quality-requirements | Optional | Quality requirement for model design. +| Parameter Design Specification | design.parameter | Recommended | Definition of how parameters shall be implemented. +| Parameter Design Quality Requirement | design.parameter.quality-requirements | Optional | Quality requirement for parameter design. +| Test Case Design Specification | design.test-case | Recommended | Definition of how test cases shall be implemented. +| Test Case Design Quality Requirement | design.test-case.quality-requirements | Optional | Quality requirement for test case design. | Simulation Environment Design Specification | design.simulation-environment | Recommended | Definition of how the simulation environment shall be implemented. +| Simulation Environment Design Quality Requirement | design.simulation-environment.quality-requirements | Optional | Quality requirement for simulation environment design. | Simulation Integration Design Specification | design.simulation-integration | Recommended | Definition of how simulation components shall be integrated. -| Test Case Design Specification | design.test-cases | Recommended | Definition of how test cases shall be implemented. +| Simulation Integration Design Quality Requirement | design.simulation-integration.quality-requirements | Optional | Quality requirement for simulation integration design. | Design Quality Assurance | design.quality-assurance | Recommended | Quality assurance measure in the design phase. | Design Verification Result | design.verification | Recommended | Result of verification activities in the design phase. -| Model Design Quality Requirement | design.models.quality-requirements | Optional | Quality requirement for model design. -| Parameter Design Quality Requirement | design.parameters.quality-requirements | Optional | Quality requirement for parameter design. -| Simulation Environment Design Quality Requirement | design.simulation-environment.quality-requirements | Optional | Quality requirement for simulation environment design. -| Simulation Integration Design Quality Requirement | design.simulation-integration.quality-requirements | Optional | Quality requirement for simulation integration design. -| Test Case Design Quality Requirement | design.test-cases.quality-requirements | Optional | Quality requirement for test case design. |=== ==== Implementation @@ -115,19 +116,19 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Simulation Model Name | implementation.model.name | Mandatory | Name of the implemented simulation model. -| Parameter Name | implementation.parameters.name | Mandatory | Name of the implemented parameter set. -| Simulation Environment Name | implementation.simulation-environment.name | Mandatory | Name of the implemented simulation environment. -| Simulation Integration Name | implementation.simulation-integration.name | Mandatory | Name of the implemented simulation integration. +| Simulation Model Name | implementation.model.name | Recommended | Name of the implemented simulation model. | Simulation Model Confidentiality Level | implementation.model.confidentiality | Recommended | Confidentiality classification for implemented model information. | Simulation Model Quality | implementation.model.quality | Recommended | Statement describing achieved model quality after implementation. -| Parameter Confidentiality Level | implementation.parameter.confidentiality | Recommended | Confidentiality classification for implemented parameter information. +| Parameter Name | implementation.parameters.name | Recommended | Name of the implemented parameter set. +| Parameter Confidentiality Level | implementation.parameter.confidentiality | Recommended | Confidentiality classification for parameter information. | Parameter Quality | implementation.parameters.quality | Recommended | Statement describing achieved parameter quality after implementation. +| Test Case Name | implementation.test-case.name | Recommended | Name of implemented test cases. +| Test Case Confidentiality Level | implementation.test-case.confidentiality | Recommended | Confidentiality classification for implemented test case information. +| Test Case Quality | implementation.test-case.quality | Recommended | Statement describing achieved test case quality after implementation. +| Simulation Environment Name | implementation.simulation-environment.name | Recommended | Name of the implemented simulation environment. | Simulation Environment Quality | implementation.simulation-environment.quality | Recommended | Statement describing achieved simulation environment quality after implementation. -| Test Case Name | implementation.test-cases.name | Recommended | Name of implemented test cases. -| Test Case Confidentiality Level | implementation.test-cases.confidentiality | Recommended | Confidentiality classification for implemented test case information. -| Test Case Quality | implementation.test-cases.quality | Recommended | Statement describing achieved test case quality after implementation. | Solver Setting | implementation.simulation-integration.settings | Recommended | Relevant simulation integration settings, such as solver settings. +| Simulation Integration Name | implementation.simulation-integration.name | Recommended | Name of the implemented simulation integration. | Simulation Integration Quality | implementation.simulation-integration.quality | Recommended | Statement describing achieved simulation integration quality after implementation. | Implementation Quality Assurance Results | implementation.quality-assurance-results | Recommended | Results of quality assurance activities in the implementation phase. | Implementation Quality Verdict | implementation.verdict | Optional | Final implementation quality decision. @@ -140,7 +141,7 @@ Note that the abbreviated explanations are not considered a normative part of th | SIC Core Name | SRMD Mapping | Obligation | Short Explanation | Used Simulation Model Name | execution.model.names | Mandatory | Name of simulation model actually used in execution. | Used Parameter Name | execution.parameters.names | Mandatory | Name of parameter set actually used in execution. -| Used Test Case Name | execution.test-cases.names | Mandatory | Name of test case actually used in execution. +| Used Test Case Name | execution.test-cases.names | Recommended | Name of test case actually used in execution. | Used Tool Name | execution.tool.name | Mandatory | Name of tool actually used in execution. | Execution Raw Data | execution.data | Recommended | Original data resulting from simulation runs before processing. | Used Tool Settings | execution.tool.settings | Recommended | Tool-specific settings applied during execution. @@ -152,7 +153,7 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Evaluation Results | evaluation.results | Mandatory | Key results produced by processing simulation output data. +| Evaluation Results | evaluation.results | Recommended | Key results produced by processing simulation output data. | Evaluation Quality-Assurance Results | evaluation.quality-assurance | Recommended | Results of quality assurance activities during evaluation. | Evaluation Quality Verdict | evaluation.verdict | Optional | Final verdict from evaluating simulation results. |=== @@ -162,9 +163,9 @@ Note that the abbreviated explanations are not considered a normative part of th [cols="2,3m,^1e,17",align="center",frame="topbot",options="header"] |=== | SIC Core Name | SRMD Mapping | Obligation | Short Explanation -| Objectives Fulfilled | fulfillment.objectives | Mandatory | Decision whether simulation objectives are fulfilled. -| Credibility Fulfilled | fulfillment.credibility | Mandatory | Decision whether credibility requirements are fulfilled. | Task Status | fulfillment.task-status | Mandatory | Overall status assessment of the simulation task. +| Quality Fulfilled | fulfillment.quality | Recommended | Decision whether simulation quality requirements are fulfilled. +| Objectives Fulfilled | fulfillment.objectives | Recommended | Decision whether simulation objectives are fulfilled. | Fulfillment Evidence | fulfillment.evidence | Recommended | Link or reference to evidence supporting fulfillment decisions. | Fulfillment Date | fulfillment.date | Recommended | Date on which fulfillment assessment is made. |=== diff --git a/docs/B___basic_subset.adoc b/docs/B___basic_subset.adoc new file mode 100644 index 0000000..319c066 --- /dev/null +++ b/docs/B___basic_subset.adoc @@ -0,0 +1,34 @@ +[appendix#basic-subset] +== Subset of SIC Core for basic usecases (Basic Subset) + +The full set of metadata attributes defined in this specification is designed to support a wide range of use cases and functionalities related to simulation activities, including search, analysis, reuse, and traceability. +However, not all of these attributes may be necessary or relevant for every use case or implementation. +The information and metadata required depend on the use case. +Furthermore, the availability of information and metadata may vary across different environments and organizations, especially in early stages of implementation. + +To support incremental adoption and implementation, this appendix defines a *basic subset* of the full SIC Core metadata that enables basic functionality for search, analysis, reuse, and traceability. + +The basic subset contains sufficient metadata to identify and understand the simulation task, the models and parameters used, and the fulfillment of simulation objectives and quality criteria. +A key factor for user acceptance is that most of this information can be provided by the used IT systems, or is readily available to users, and does not require significant additional effort to be collected and documented. + +This basic subset of SIC core can be used as a starting point in the implementation of metadata for simulation, while allowing easy growth into a more fuller use of the SIC Core metadata as needed and as information becomes available. + +See <> for the actual definition of the attributes in the basic subset, as listed below. + +[cols="1>m,2^e,7<",width="100%",align="center",frame="topbot",options="header"] +|=== +| Attribute Name| Category | Obligation | Description | Typical Source +| <> | Administrative | Recommended | Unique name of the ordering project | Project management tool +| <> | Administrative | Recommended | Unique name of the specific product | Project management tool +| <> | Administrative | Recommended | Unique name of the Simulation Request | Project management tool +| <> | Administrative | Mandatory | Unique name of the simulation task | Project management tool +| <> | Analysis | Mandatory | System, component, or product being analyzed | Tool / system +| <> | Analysis | Mandatory | Objective or purpose of the simulation | User +| <> | Analysis | Recommended | Criteria used to evaluate simulation success | User +| <> | Execution | Mandatory | Model used for the simulation | Tool / system +| <> | Execution | Mandatory | Parameter used for the simulation | user (selection) +| <> | Execution | Mandatory | Tool used for the simulation | Tool / system +| <> | Fulfillment | Mandatory | Is the task still in progress abortet, finished | User +| <> | Fulfillment | Recommended | Documentation of the quality fulfillment decision | User +| <> | Fulfillment | Recommended | Documentation of the objectives fulfillment decision | User +|=== diff --git a/docs/images/CSP.png b/docs/images/CSP.png new file mode 100644 index 0000000..0c9f7f9 Binary files /dev/null and b/docs/images/CSP.png differ diff --git a/docs/index.adoc b/docs/index.adoc index 8953833..d8492c1 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -25,3 +25,5 @@ include::3___conformance.adoc[] include::4___literature.adoc[] include::A___mapping_srmd.adoc[] + +include::B___basic_subset.adoc[]