Support for Simulation resource meta data (SRMD)

[robha67]

Describe the solution you'd like
A clear and concise description of what you want to happen.

The ability to parse(and act on)and create any meta-data, related to a specific SSP or FMU, expressed in the SRMD format of the SSP Traceability specification. Examples of relevant meta-data are: generation date and time, repository tags, OMSimulator version, etc. However, the end user should be able to specify what information to store.

[arun3688]

@robha67 is this a new feature request and what is SRMD format ?

[robha67]

Yes, it is a new feature and SRMD is an xml format specified in SSP Traceability specification https://pmsfit.github.io/SSPTraceability/master/

[robha67]

@arun3688 I am thinking something like the api for the exportSSVTemplate command. Currently there is not a way in SSP to add a reference to the resulting SRMD file, except for through vendor specific annotations, but I believe there will be a solution in SSP 2.0. Maybe that proposal could be used?

[robha67]

@lochel or @arun3688 : Do you know how to add the openscaling label retroactivly to this issue? Is that possible or do I have to close this one, create a new issue with the same information with the correct label?

[lochel]

You can add the label retroactively without closing or recreating the issue. I just added the "project/openscaling" label for this issue. If you need to do it in the future, just click on "Labels" on the right and select the appropriate one. If it doesn’t work for you, there might be permission issues. Please feel free to ping me if that's the case!

[robha67]

First small use-case: port the tool specific xml describing what simulation outputs to store to the SRMD format. This is a good example for learning about the SRMD format and implementing basic export and import.

[robha67]

Second use-case: Capture any (to the degree needed) manipulation to the SSP that has been done via the OMS api. For example, the addition of a resource. The level of detail that is needed need to be discussed further.

[adrpo]

Yes, it is a new feature and SRMD is an xml format specified in SSP Traceability specification https://pmsfit.github.io/SSPTraceability/master/

This link doesn't seem to exist anymore, can you please update it to a proper one?

[robha67]

SRMD11.txt
@arun3688 I uploaded the SRMD xsd but I had to change the file extension in order to be able to attach the file.

[adrpo]

@robha67 you can zip it and then attach anything

[robha67]

SRMD_example_D16.zip
thank you @adrpo, an openscaling srmd example is attached to this comment

@just-amin

[lenaRB]

A first task for @just-amin in collaboration with @arun3688 and @robha67

[robha67]

Proposed steps of implementation listed below (similar to those of the SSV API functions)

1. Implement API function to add SRMD file to resources folder of an SSP
2. Implement API function to remove an existing SRMD file from the resources
3. Implement functionality to reference an SRMD file (that is available in the resources folder) from any SSP artifact(i.e. SSD, SSV, SSM) utilizing the GEMetaData attribute of the SSP2.0 release candidate.

Later, Investigate what meta-data information needs to be stored when developing or utilizing FMUs or SSP files in OMSimulator. This meta-data could/should be stored in the SRMD format (or other formats of the SSP-Traceability specification i.e STMD and DTMD).

[lenaRB]

discussed in a meeting - 1-2 bullets already supported, but formatting needs to be checked, for point 3 - add the support for the GEMetaData attribute that allows to reference a resource - add a dedicated API call

[lenaRB]

@robha67 - make a new example for the SRMD file within the SSP

@arun3688 - found the issue on windows, will take care of it

Automatic validity check when the SSP is unpacked, now it is checked later -- everyone agrees on this - @just-amin - will add support for this