Skip to content
/ Core Public

Core framework for traceability link recovery between architecture documentation and models while identifying inconsistencies.

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE.md
Unknown
license-header
Notifications You must be signed in to change notification settings

ArDoCo/Core

Repository files navigation

Core

SonarCloud

Maven Verify

The goal of this project is to connect architecture documentation and models while identifying missing or deviating elements. An element can be any representable item of the model, like a component or a relation.

This project is based on the master thesis Linking Software Architecture Documentation and Models.

For more information about the setup or the architecture have a look on the wiki.

CLI

The Core Project contains a CLI that currently supports to find trace links between PCM Models and Textual SW Architecture Documentation. The CLI is part of the pipeline module of this project. The PCM models have to be converted to ontologies using Ecore2OWL.

Usage

java -jar ardoco-core-pipeline \

	-n NAME_OF_THE_PROJECT (will be stored in the results)
	-m PATH_TO_THE_PCM_MODEL_AS_OWL (use Ecore2OWL to obtain PCM models as ontology)
	-o PATH_TO_OUTPUT_FOLDER

	Text input parameters (one of them has to be provided):
	-t PATH_TO_PLAIN_TEXT
	-p (provided ontology contains the preprocessed text that should be used instead of the text)

	Optional Parameters:

	-c CONFIG_FILE (the config file can override any default configuration using the standard property syntax (see config files in src/main/resources)

Case Studies

To test the Core, you could use case studies provided in ..