Provided by the PANORAMA Research Project.
- The MobSTr dataset: Model-Based Safety Assurance and Traceability
This repository contains artifacts such as requirements and architecture models for the MobSTr dataset, based on the WATERS FMTV 2019 challenge. The MobSTr dataset provides a number of artifacts and traceability links for use in demonstrating model-based safety assurance and traceability.
The WATERS FMTV 2019 challenge is an industrial case study used as part of the 10th International Workshop on Analysis Tools and Methodologies for Embedded and Real-time Systems (WATERS). It was originally proposed by Arne Hamann, Dakshina Dasari, and Falk Wurst, Corporate Research Robert Bosch GmbH and Ignacio Sañudo, Nicola Capodieci, Paolo Burgio and Marko Bertogna, University of Modena and Reggio Emilia.
The artifacts in this repository are based on the challenge description and are provided by the PANORAMA research project, specifically by the contributors. The corresponding Amalthea model for the challenge is included here. The original file can be found in the Eclipse APP4MC Github Repository.
The system described in the WATERS FMTV 2019 challenge and consequently in the MobSTr dataset is an automated driving system that includes lane following and routing features. The original challenge definition was used as a starting point, but refinements have been applied when necessary. We make no claim on the completeness or correctness of any of the artifacts available for download here.
| Artifact | Description |
|---|---|
| org.panorama-research.mobstr.amalthea | The Amalthea model of the WATERS FMTV 2019 Challenge. You will need Eclipse APP4MC to open the model. |
| org.panorama-research.mobstr.architecture | A UML model of the components of the system. You will need Eclipse Papyrus to open the model. |
| org.panorama-research.mobstr.artifacts | A UML model of the artifacts that are part of this dataset. This information model is used as the foundation for the TIM. You will need Eclipse Papyrus to open the model. |
| org.panorama-research.mobstr.assumptions | An Excel spreadsheet with additional assumptions. |
| org.panorama-research.mobstr.fmea | An ODE model containing the results of a Failure Mode and Effects Analysis performed for the system. |
| org.panorama-research.mobstr.fta | An ODE model containing a component fault tree and exemplary fault trees for all identified hazards. |
| org.panorama-research.mobstr.hazards | An Excel spreadsheet with the identified hazards of the system. |
| org.panorama-research.mobstr.requirements | An Excel spreadsheet with the requirements of the system, including safety requirements. |
| org.panorama-research.mobstr.safetycase | An ODE model containing the safety case for the system. |
| org.panorama-research.mobstr.src | Source code generated out of the Amalthea model for two simulators. Please refer to the README file in the folder for more information. |
| org.panorama-research.mobstr.tim | An Eclipse plugin project containing the implementation of the traceability information model (TIM) for Eclipse Capra (see below). |
| org.panorama-research.mobstr.tim.test | An Eclipse test plugin with test cases for the TIM implementation. |
| __WorkspaceTraceModels | The traceability links between the different artifacts conforming to the TIM. Please note that the links are partial, i.e., not all artifacts that should be linked are currently connected by a trace link. |
| WATERS_Industrial_Challenge_2019_final.pdf | The original WATERS FMTV 2019 Challenge description on which the artifacts in this repository are based. |
The MobSTr dataset comes with its own custom traceability information model (TIM). The TIM has been designed to fulfill the needs of an organisation that develops a safety-critical product. Therefore, the trace link types, the directionality of the trace link types, and the artifacts they connect are based on the goal to allow constructing a safety case from the existing artifacts as easily as possible and to trace all required evidence from the safety case. In particular, the trace link types are informed by the traceability described in ISO 26262.
Each combination of artifacts that needs to be traced has a unique trace link type which also carries a unique name that reflects its semantics. All trace link types are shown in the figure below. Please note that the cardinalities in the figure differ from the cardinalities that are implemented in the custom TIM (see below). The reason is that while it might make sense that not all hazards are assigned to a safety goal on the global level (e.g., while hazards are developed and refined and safety goals have not yet been updated), no trace links would exist in such cases.
It is possible to use the MobSTr dataset using a custom Eclipse installation that contains all tools required to access the artifacts. This includes Eclipse Papyrus, the ODE Editor, and APP4MC.
The repository also contains a custom traceability information model (TIM) that defines which link types can be created between the different artifacts. The current TIM is based on the artifact model in project org.panorama-research.mobstr.artifacts and is implemented for use in Eclipse Capra. The TIM project is located in org.panorama-research.mobstr.tim.
Use the following instructions to install Eclipse and all necessary components of the MobSTr dataset:
- Download the Eclipse Installer from here.
- Install Eclipse Capra and the MobSTr Dataset
- Open the Eclipse Installer.
- If necessary, switch to "Advanced Mode" using the Hamburger menu in the top right corner (if you don't see that menu, you are already in advanced mode).
- Select "Eclipse for Committers".
- Select JDK 11 in the list of possible JREs (Note: please make sure that Java 11 is installed locally on your machine. If that is not the case, please download Java 11 from here and locate it on your hard drive in this step).
- The recommended version of Eclipse is 2022-03 at the time of writing. Please select this version from the "Product Version" dropdown menu.
- Click Next.
- On the second page, drag and drop this link onto the "Eclipse Projects" entry in the list.
- Make sure that the checkbox before the entry "Eclipse Capra for MobSTr" is selected.
- Click next and follow the rest of the installation process. The Eclipse installer will then download the necessary files, close itself, and start the newly downloaded Eclipse which will then complete the setup. By the end of it, you will have all necessary files on your local machine to start using Eclipse Capra with the MobSTr dataset.
- You might need to install Graphviz to make the "Capra PlantUML Viewer" work. Please follow the installation instructions for your platform.
- Create a new run configuration
- Click on Run --> Run Configurations and create a new Eclipse Application Configuration.
- Select a new folder as the workspace for your Eclipse application.
- Click "Apply", then "Run".
- Depending on your chosen Eclipse version and target platform, you might see a warning about a dependency to
http-client. This message can be safely ignored.
- Import the MobSTr projects into the runtime Eclipse workspace
- Once the new workspace opens, import the projects in this repository (apart from
org.panorama-research.mobstr.timandorg.panorama-research.mobstr.tim.test). - Go to Window --> Perspectives and switch to the Capra perspective.
- Go to the Eclipse preferences, open the "Capra Traceability" tree and select "Office Documents". Select "Use this column as the ID" and make sure the column is "A". The MobSTr dataset uses the first column in Excel files to identify requirements and hazards.
- Start creating and using traceability links: Follow this video to create and visualize traceability links.
If you prefer a more manual installation, please refer to this separate guide.
During the custom installation process on Windows, it may happen that the process is not completed successfully. This error can be recognized by the fact that no further installation window opens after starting the newly downloaded Eclipse instance and no projects are shown in the Project Explorer. Please delete or rename the temporary .eclipse and .p2 directories in your home directory and start the installation process again.
This can happen when the MobSTr projects are imported to the runtime workspace for the first time. Simply restart your runtime Eclipse to fix the issue. Also make sure that you followed the instructions for setting the column as the ID for Office documents as described above.
Please make sure that you have JDK 11 installed and that this is the Java runtime your Eclipse is using. Newer JDK versions might not be 100% compatible with Eclipse Capra at this point.
In case you get an error that the wrong APP4MC version is installed, please open mobstr.amxmi in a text editor and change the model version to the APP4MC version you have installed (usually either 0.9.7 or 1.0.0, depending on the version of Eclipse that you are using and thus the target platform chosen for Eclipse Capra).
If you see compilation errors in mobstr-tim.xcore, please make sure that the "UML2 Extender SDK" is installed in your Eclipse. That feature contains the genmodels for UML2 which are required for XCore to compile the TIM. It can be found on the release update site.
The MobSTr dataset is intended to be used as an exemplar and as a dataset for evaluation in all research for which it is relevant. We track the known uses of the dataset here.
Stable releases of MobSTr are published to Zenodo. You can find the current version here. If you want to cite the dataset in your own work, please use the bibliographical information on the Zenodo page or this BibTeX entry:
@misc{mobstr_2021_06,
author={Jan-Philipp Steghöfer and Björn Koopmann
and Jan Steffen Becker and Ingo Stierand
and Marc Zeller and Maria Bonner
and David Schmelter and Salome Maro},
title={The MobSTr dataset: Model-Based Safety Assurance and Traceability},
DOI={10.5281/zenodo.4981481},
publisher={Zenodo},
year={2021},
month={Jun}
}
We have also published a short paper about MobSTr at the 29th IEEE International Requirements Engineering Conference. To cite it, please use the following BibTex entry:
@inproceedings{
author={Jan-Philipp Steghöfer and Björn Koopmann
and Jan Steffen Becker and Ingo Stierand
and Marc Zeller and Maria Bonner
and David Schmelter and Salome Maro},
title={The MobSTr Dataset -- An Exemplar for Traceability and Model-based Safety Assessment},
booktitle={Proceedings of the 29th IEEE International Requirements Engineering Conference, Notre Dame, South Bend, USA}
publisher={IEEE},
year={2021},
month={Aug}
}
All artifacts provided here are under Eclipse Public License v2.0. Copyright 2020, 2021 by contributors.