Skip to content

Commit

Permalink
Merge pull request #1 from catenax-eV/feature/tractus-x_adaption
Browse files Browse the repository at this point in the history
Feature/tractus x adaption
  • Loading branch information
jSchuetz88 authored Jul 25, 2024
2 parents 9d8bf46 + 8228236 commit b16fa5f
Show file tree
Hide file tree
Showing 29 changed files with 289 additions and 208 deletions.
31 changes: 0 additions & 31 deletions AUTHORS.md

This file was deleted.

6 changes: 6 additions & 0 deletions DEPENDENCIES
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pypi/pypi/-/graphviz/0.20.1, MIT, restricted, clearlydefined
pypi/pypi/-/isodate/0.6.1, BSD-3-Clause, approved, #1422
pypi/pypi/-/mdutils/1.6.0, MIT, approved, clearlydefined
pypi/pypi/-/pyparsing/3.1.1, GPL-1.0-or-later AND GPL-3.0-only AND MIT AND MIT AND (MIT AND Python-2.0) AND BSD-3-Clause AND BSD-2-Clause AND LicenseRef-scancode-other-permissive AND MIT-CMU AND (LicenseRef-scancode-mit-synopsys AND LicenseRef-scancode-proprietary-license AND MIT), approved, #15047
pypi/pypi/-/rdflib/7.0.0, BSD-2-Clause, approved, clearlydefined
pypi/pypi/-/six/1.16.0, MIT, approved, clearlydefined
79 changes: 19 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
<!--
* Copyright (c) 2022,2023 Contributors to the Catena-X Association
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Apache License, Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
* SPDX-License-Identifier: Apache-2.0
# Copyright (c) 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This work is made available under the terms of the
# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
# which is available at
# https://creativecommons.org/licenses/by/4.0/legalcode.
#
# SPDX-License-Identifier: CC-BY-4.0
-->

# Ontology Models to realize federated query in Catena-X
# Ontology Models to realize federated query

- This repository hosts ontologies based on the [CX - 0067 Ontology Models to realize federated query in Catena-X v.1.1.0](https://catena-x.net/de/standard-library) standard to realize [Knowledge Agent](https://eclipse-tractusx.github.io/docs-kits/kits/knowledge-agents/adoption-view/intro) applications.
- This repository hosts ontologies based on the [CX - 0067 Ontology Models to realize federated query in Catena-X v.1.1.0](https://catenax-ev.github.io/docs/next/standards/CX-0067-OntologyModelsToRealizeFederatedQueryInCatenaX) standard to realize [Knowledge Agent](https://eclipse-tractusx.github.io/docs-kits/kits/knowledge-agents/adoption-view/intro) applications.
- The Catena-X Ontology and its initial Catena-X Taxonomy are not intended to be a world model. Instead, it is intended to be an integrative framework with a focus on automotive manufacturing. Therefore, our focus is on defining practical domain ontologies. All definitions in a domain ontology should belong to the same namespace (which is the technical key of the domain) and should use a common prefix. Domain ontologies can refer to classes of other domains by importing concrete versions.
- The Catena-X taxonomy contains all concepts used in domain ontologies. Furthermore, the defined concepts are not only used in the knowledge agent approach, but are also made available to all Catena-X applications.
</br>
Expand All @@ -28,12 +23,12 @@
<img src="images/ontologies.png" alt="image" width="900" height="auto" />
</div>

## Ontology Development & Governance Process
## Ontology Development

- The ontologies can be developed based on the ontology governance process.
- The ontologies are developed using the [protégé editor](https://protege.stanford.edu/). Therefore, we prefer to use this editor.
<!-- & Governance Process -->
<!-- The ontologies can be developed based on the ontology governance process.! -->
- The ontologies are developed using the [protégé editor](https://protege.stanford.edu/). Therefore, we recommend to use this editor.
- After the development of a new ontology is finished, the documentation is automatically generated as a Markdown file and stored in the repository. In addition, the ontologies are published at [w3id.org Catena-X](https://w3id.org/catenax). This also allows access to all versions.
- You can download the protégé editor, import the core ontology and start modeling!

## Provisioning of Ontology and Taxanomy

Expand All @@ -58,43 +53,7 @@ Taxonomy:
- [Core Taxonomy](docs/core_taxonomy.md)
- [Asset Taxonomy](docs/asset_taxonomy.md)

## Related Information
Dependencies
- [Requirements](ontology_tools/requirements.txt)

* See the [Authors file](AUTHORS.md)
* See the [License file](LICENSE)
* See the [Code of conduct](CODE_OF_CONDUCT.md)
* See the [Contribution guidelines](CONTRIBUTING.md)
* See the [Dependencies and their licenses](NOTICE.md)
* See the [Security disclaimer](SECURITY.md)
* See the [Changelog](CHANGELOG.md)

# Dependencies of Tractus-X Knowledge Agents Ontology

The following is a simple type of single-level Software-BOM for all official open source products of Tractus-X Knowledge Agents.

* Component - The specific sub-component of the Epic/Product (* for all)
* Library/Module - The library or module that the Product/Component is depending on
* Stage - The kind of dependency
* Compile - The library is needed to compile the source code of the component into the target artifact (runtime)
* Test - The library is needed to test the target artifact
* Packaging - The library is needed to test the target artifact before, while and/or after packaging it
* Runtime - The library is shipped as a part of the target artifact (runtime)
* Provided - The library is not shipped as a part of the target artifact, but needed in it runtime
* All - The library is needed at all Stages
* Version - the version of the library that the component is dependant upon
* License - the license identifier
* Comment - any further remarks on the kind of dependency

| Component | Library/Module | Version | Stage | License | Comment |
| -- | --- | --- | --- | --- | ---|
| * | * | [Apache Maven](https://maven.apache.org) | >=3.8 | Compile + Test + Packaging | Apache License 2.0 | |
| * | * | Docker Engine | >=20.10.17 | Packaging + Provided | Apache License 2.0 | |
| * | * | [kubernetes](https://kubernetes.io/de/)/[helm](https://helm.sh/) | >=1.20/3.9 | Provided | Apache License 2.0 | |
| * | * | [Python](https://www.python.org/) | >=3.9 | Test + Packaging + Provided | Zero Clause BSD | |
| Tools | [OWLApi](https://github.com/owlcs/owlapi) | >=5.1 | Compile + Test + Packaging | LGPL and Apache License | |
| Tools | [OWL2VOWL](https://github.com/VisualDataWeb/OWL2VOWL) | >=0.3.7 | Compile + Test + Packaging | MIT License | |
| Tools | [SLF4J](https://www.slf4j.org) | >=2.0.0 | Compile + Test + Packaging | MIT | |
| Tools | [Junit Jupiter](https://junit.org) | >=5 | Test | MIT | |
| Tools | [NodeJS](https://nodejs.org/en/) | >=14 | Compile + Packaging | MIT (Main) + Various Extensions | Only for Json2Sql|
| Tools | [Jackson](https://github.com/FasterXML/jackson) | >=2.12.6 | Compile + Test + Packaging | Apache License 2.0 | |
| Tools | [RDFlib](https://rdflib.readthedocs.io/en/stable/) | >=6.2 | Compile + Test + Packaging | BSD-3 | |
17 changes: 12 additions & 5 deletions docs/asset_taxonomy.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@




# Asset Taxonomy


**Title:** Asset Taxonomy

**Description:** This taxonomy represents and contains concepts of the asset.
Expand Down Expand Up @@ -45,3 +40,15 @@
|<span id="DcmWeekBasedCapacityGroup">DcmWeekBasedCapacityGroup</span>|Receive Week Based Capacity Group DCM|API to receive a Week Based Capacity Group in DCM context|[Asset](#Asset) ||
|<span id="DcmIdBasedRequestForUpdate">DcmIdBasedRequestForUpdate</span>|Receive ID Based Request for Update DCM|API to receive an ID Based Request for Update in DCM context|[Asset](#Asset) ||
|<span id="DcmIdBasedComment">DcmIdBasedComment</span>|Receive ID Based Comment for DCM|API to receive an ID Based Comment in DCM context|[Asset](#Asset) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/behaviour_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,15 @@ classDiagram
|<span id="healthIndicatorValues">healthIndicatorValues</span>|Health Indicator Values are percentages.|[HealthIndicatorResult](#HealthIndicatorResult) |json:Object |[returnValue](./function_ontology.md#returnValue) |
|<span id="metadata">metadata</span>|Additional Metadata of the Loadspectrum.|[RemainingUsefulLife](#RemainingUsefulLife) |json:Object |[prognosisFunctionArgument](#prognosisFunctionArgument) |
|<span id="notification">notification</span>|An optional notification output template.|[RemainingUsefulLife](#RemainingUsefulLife) |json:Object |[prognosisFunctionArgument](#prognosisFunctionArgument) |

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/bill-of-material_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,15 @@ classDiagram
|<span id="concept">concept</span>|Lists the concepts of a bill of material.|[BillOfMaterial](#BillOfMaterial) |[ConceptualObject](./core_ontology.md#ConceptualObject) ||
|<span id="hasBom">hasBom</span>|Refers the bill of material of an assembly.|[PhysicalObject](./core_ontology.md#PhysicalObject) |[BillOfMaterial](#BillOfMaterial) ||
|<span id="supplier">supplier</span>|The supplier of the component(s).|[BillOfMaterial](#BillOfMaterial) |[BusinessPartner](./common_ontology.md#BusinessPartner) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/common_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,15 @@ classDiagram
| :--- | :--- | :--- | :--- | :--- |
|<span id="hasDataspaceConnector">hasDataspaceConnector</span>|This property describes which connectors belong to which business partners.|[BusinessPartner](#BusinessPartner) |[DataspaceConnector](#DataspaceConnector) ||
|<span id="offers">offers</span>|This property refers to the offered assets.|[DataspaceConnector](#DataspaceConnector) |[Asset](#Asset) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/core_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,15 @@ classDiagram
|<span id="refersToPhysicalObject">refersToPhysicalObject</span>|This property refers to actively or passively used physical objects in an Activity.|[Activity](#Activity) |[PhysicalObject](#PhysicalObject) ||
|<span id="relatedToPlace">relatedToPlace</span>|This property describes that an actor has a relationship to a particular place, such as reside, own, or manage, etc.|[Actor](#Actor) |[Place](#Place) ||
|<span id="takesPlaceAt">takesPlaceAt</span>|This property describes the spatial location of an activity.|[Activity](#Activity) |[Place](#Place) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/core_taxonomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,15 @@
|<span id="Analysis">Analysis</span>|Analysis|An analysis is an activity that includes all types of reliability and quality analyses.|[Activity](#Activity) |[Diagnosis](#Diagnosis) |
|<span id="LoadSpectrumAnalysis">LoadSpectrumAnalysis</span>|Load Spectrum Analysis|Load spectrum analysis is an analysis that calculates load spectrum values for a vehicle part.|[Analysis](#Analysis) ||
|<span id="Diagnosis">Diagnosis</span>|Diagnosis|Vehicle diagnosis is the identification of a problem or the cause and location of a problem.|[Analysis](#Analysis) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/function_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,15 @@ classDiagram
|<span id="resultConfigurationProperty">resultConfigurationProperty</span>|API configuration property for Result.|[Result](#Result) |||
|<span id="outputProperty">outputProperty</span>|Determines a path/name in the output response under which all output arguments are encoded. Default is '.'|[Result](#Result) |xsd:string |[resultConfigurationProperty](#resultConfigurationProperty) |
|<span id="resultIdProperty">resultIdProperty</span>|Determines a path in the output response under which the IRI of the result component will be transmitted.|[Result](#Result) |xsd:string |[resultConfigurationProperty](#resultConfigurationProperty) |

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/ontology_governance_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,15 @@

#### **Publishing Process**
- Publish the new version in W3id.org

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/reliability_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,15 @@ classDiagram
|<span id="possibleCause">possibleCause</span>|Refers to possible cause.|[DiagnosticTroubleCode](#DiagnosticTroubleCode) |[ErrorCause](#ErrorCause) ||
|<span id="result">result</span>|Refers to analysis result.|[Analysis](#Analysis) |[AnalysisResult](#AnalysisResult) |[refersToConceptualObject](./core_ontology.md#refersToConceptualObject) |
|<span id="value">value</span>|Refers to load spectrum value.|[LoadSpectrum](#LoadSpectrum) |[LoadSpectrumValue](#LoadSpectrumValue) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/supply-chain_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,15 @@ classDiagram
|<span id="good">good</span>|Refers to the goods in the supply chain.|[SupplyChain](#SupplyChain) |[PhysicalObject](./core_ontology.md#PhysicalObject) ||
|<span id="recipient">recipient</span>|Refers to the recipient.|[SupplyChain](#SupplyChain) |[BusinessPartner](./common_ontology.md#BusinessPartner) ||
|<span id="supplier">supplier</span>|Refers to the supplier.|[SupplyChain](#SupplyChain) |[BusinessPartner](./common_ontology.md#BusinessPartner) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
12 changes: 12 additions & 0 deletions docs/vehicle_ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,15 @@ classDiagram
|<span id="hasSubpart">hasSubpart</span>|Refes to parts of main vehicle parts.|[Part](#Part) |[Part](#Part) ||
|<span id="isPartOf">isPartOf</span>|Inverse of 'hasPart' property.|[Part](#Part) |[Vehicle](#Vehicle) ||
|<span id="isSubpartOf">isSubpartOf</span>|Inverse of 'hasSubpart' property.|[Part](#Part) |[Part](#Part) ||

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- Copyright (c) 2024 T-Systems International GmbH
- Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- Copyright (c) 2024 ZF Friedrichshafen AG
- Copyright (c) 2024 Mercedes-Benz AG
- Copyright (c) 2024 SAP AG
- Copyright (c) 2024 Catena-X Association
- Copyright (c) 2024 Contributors to the Eclipse Foundation
14 changes: 14 additions & 0 deletions ontology.ttl
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
#######################################################################
# Copyright (c) 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This work is made available under the terms of the
# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
# which is available at
# https://creativecommons.org/licenses/by/4.0/legalcode.
#
# SPDX-License-Identifier: CC-BY-4.0
#######################################################################

@prefix : <https://w3id.org/catenax/ontology/core#> .
@prefix cx-behaviour: <https://w3id.org/catenax/ontology/behaviour#> .
@prefix cx-bom: <https://w3id.org/catenax/ontology/bill-of-material#> .
Expand Down
Loading

0 comments on commit b16fa5f

Please sign in to comment.