cognite-neat 0.75.7__py3-none-any.whl → 0.75.9__py3-none-any.whl

cognite/neat/legacy/workflows/examples/Ontology_to_Data_Model/workflow.yaml

@@ -0,0 +1,116 @@
+configs: []
+description: null
+implementation_module: null
+name: Ontology to Data Model
+steps:
+  - complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_trigger
+    label: Trigger
+    max_retries: 0
+    method: null
+    params: {}
+    retry_delay: 3
+    stype: http_trigger
+    system_component_id: null
+    transition_to:
+      - step_128344
+      - dowload_ontology
+    trigger: true
+    ui_config:
+      pos_x: 524
+      pos_y: 259
+  - complex_configs: {}
+    configs:
+      excel_file_path: rules/LIS-14-rules.xlsx
+      make_compliant: "True"
+      ontology_file_path: staging/LIS-14.ttl
+    description: null
+    enabled: true
+    id: onotology2rules
+    label: Import Ontology to Rules
+    max_retries: 0
+    method: ImportOntologyToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - load_generated_rules
+      - import_generated_rules
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 403
+  - complex_configs: {}
+    configs:
+      file_name: LIS-14-rules.xlsx
+      validation_report_file: rules_validation_report.txt
+      validation_report_storage_dir: rules_validation_report
+      version: ""
+    description: null
+    enabled: true
+    id: import_generated_rules
+    label: Import Generated Rules
+    max_retries: 0
+    method: ImportExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_59017
+      - step_829062
+      - export_rules_to_graphql_schema
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 490
+  - complex_configs: {}
+    configs:
+      api_url: https://rds.posccaesar.org/ontology/lis14/ont/core/2.0/LIS-14.ttl
+      auth_mode: none
+      http_method: GET
+      output_file_path: staging/LIS-14.ttl
+      password: ""
+      response_destination: file
+      token: ""
+      username: ""
+    description: null
+    enabled: true
+    id: dowload_ontology
+    label: Download Ontology
+    max_retries: 0
+    method: DownloadDataFromRestApiToFile
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - onotology2rules
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 333
+  - complex_configs: {}
+    configs:
+      file_name: ""
+      storage_dir: staging
+    description: null
+    enabled: true
+    id: export_rules_to_graphql_schema
+    label: Export Rules to GraphQL Schema
+    max_retries: 0
+    method: ExportRulesToGraphQLSchema
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+      pos_x: 525
+      pos_y: 577
+system_components: []

cognite/neat/legacy/workflows/examples/Validate_Rules/workflow.yaml

@@ -0,0 +1,67 @@
+configs: []
+description: null
+implementation_module: null
+name: Validate Rules
+steps:
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_validate_rules
+    label: Validate Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_942973
+    - step_715590
+    trigger: false
+    ui_config:
+        pos_x: 558
+        pos_y: 97
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_rules
+    label: Upload Rules Spreadsheets
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_31642
+    - step_validate_rules
+    trigger: true
+    ui_config:
+        pos_x: 558
+        pos_y: -14
+-   complex_configs: {}
+    configs:
+        Output role format: input
+        Styling: default
+    description: null
+    enabled: true
+    id: step_715590
+    label: Convert Rules
+    max_retries: 0
+    method: RulesToExcel
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 558
+        pos_y: 217
+system_components: []

cognite/neat/legacy/workflows/examples/Validate_Solution_Model/workflow.yaml

@@ -0,0 +1,64 @@
+configs: []
+description: null
+implementation_module: null
+name: Validate Solution Model
+steps:
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_769298
+    label: Upload File
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_399494
+    trigger: true
+    ui_config:
+        pos_x: 627
+        pos_y: -19
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_399494
+    label: Import Excel
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_273233
+    trigger: false
+    ui_config:
+        pos_x: 627
+        pos_y: 66
+-   complex_configs: {}
+    configs:
+        Report Formatter: BasicHTML
+    description: null
+    enabled: true
+    id: step_273233
+    label: Validate Against CDF
+    max_retries: 0
+    method: ValidateRulesAgainstCDF
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 627
+        pos_y: 154
+system_components: []

cognite/neat/legacy/workflows/examples/Visualize_Data_Model_Using_Mock_Graph/workflow.yaml

@@ -0,0 +1,95 @@
+configs: []
+description: null
+implementation_module: null
+name: Visualize Data Model Using Mock Graph
+steps:
+  - complex_configs: {}
+    configs:
+      File name: information-architect-david.xlsx
+      Report formatter: BasicHTML
+      Role: infer
+    description: null
+    enabled: true
+    id: step_verify_rules
+    label: Verify Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_configure_graph_store
+    trigger: false
+    ui_config:
+      pos_x: 507
+      pos_y: 250
+  - complex_configs: {}
+    configs:
+      Disk storage directory: mock-graph-store
+      Graph: source
+      Graph store type: oxigraph
+      GraphDB API root URL: ""
+      Init procedure: reset
+      Query URL: ""
+      Update URL: ""
+    description: null
+    enabled: true
+    id: step_configure_graph_store
+    label: Configure Graph Store
+    max_retries: 0
+    method: GraphStoreConfiguration
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_166101
+      - step_mock_graph_generation
+    trigger: false
+    ui_config:
+      pos_x: 506
+      pos_y: 314
+  - complex_configs: {}
+    configs:
+      Class count:
+        '{"WindTurbine" : 1, "WindFarm" : 1, "OffshoreSubstation" : 1,
+        "DistributionSubstation" : 1, "OnshoreSubstation" : 1, "ArrayCable" :
+        1, "ExportCable" : 1, "Transmission" : 1, "DistributionLine" : 1, "Meter"
+        : 1, "ElectricCarCharger" : 1}'
+      Graph: source
+    description: null
+    enabled: true
+    id: step_mock_graph_generation
+    label: Generate Mock Graph
+    max_retries: 0
+    method: GraphFromMockData
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+      pos_x: 506
+      pos_y: 390
+  - complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_rules
+    label: Upload Rules
+    max_retries: 0
+    method: null
+    params:
+      file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+      - step_verify_rules
+    trigger: true
+    ui_config:
+      pos_x: 507
+      pos_y: 177
+system_components: []

cognite/neat/legacy/workflows/examples/Visualize_Semantic_Data_Model/workflow.yaml

@@ -0,0 +1,111 @@
+configs: []
+description: null
+implementation_module: null
+name: Visualize Semantic Data Model
+steps:
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_excel_rules
+    label: Upload Excel Rules
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_421523
+    - step_excel_to_rules
+    trigger: true
+    ui_config:
+        pos_x: 498
+        pos_y: 149
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_excel_to_rules
+    label: Import and Validate Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_rules_to_ontology
+    trigger: false
+    ui_config:
+        pos_x: 497
+        pos_y: 234
+-   complex_configs: {}
+    configs:
+        File path: staging/semantic-data-model.ttl
+    description: null
+    enabled: true
+    id: step_rules_to_ontology
+    label: Rules to Ontology
+    max_retries: 0
+    method: RulesToSemanticDataModel
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_configure_graph_store
+    trigger: false
+    ui_config:
+        pos_x: 497
+        pos_y: 323
+-   complex_configs: {}
+    configs:
+        Disk storage directory: semantic-data-model
+        Graph: source
+        Graph store type: oxigraph
+        GraphDB API root URL: ''
+        Init procedure: reset
+        Query URL: ''
+        Update URL: ''
+    description: null
+    enabled: true
+    id: step_configure_graph_store
+    label: Configure Graph Store
+    max_retries: 0
+    method: GraphStoreConfiguration
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_load_semantic_data_model
+    trigger: false
+    ui_config:
+        pos_x: 495
+        pos_y: 399
+-   complex_configs: {}
+    configs:
+        Add base URI: 'False'
+        File path: staging/semantic-data-model.ttl
+        MIME type: text/turtle
+    description: null
+    enabled: true
+    id: step_load_semantic_data_model
+    label: Load Semantic Data Model
+    max_retries: 0
+    method: GraphFromRdfFile
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 495
+        pos_y: 476
+system_components: []

cognite/neat/rules/analysis/_base.py

@@ -3,7 +3,7 @@ from abc import ABC, abstractmethod
 from typing import Generic, TypeVar
 
 from cognite.neat.rules._shared import Rules
-from cognite.neat.rules.models.rules._types import ClassEntity
+from cognite.neat.rules.models.entities import ClassEntity
 
 if sys.version_info >= (3, 11):
     from enum import StrEnum

cognite/neat/rules/analysis/_information_rules.py

@@ -7,10 +7,10 @@ from typing import Any, cast
 import pandas as pd
 from pydantic import ValidationError
 
+from cognite.neat.rules.models.entities import ClassEntity, EntityTypes, ParentClassEntity, ReferenceEntity
 from cognite.neat.rules.models.rdfpath import TransformationRuleType
 from cognite.neat.rules.models.rules._base import SchemaCompleteness
 from cognite.neat.rules.models.rules._information_rules import InformationClass, InformationProperty, InformationRules
-from cognite.neat.rules.models.rules._types._base import ClassEntity, EntityTypes, ParentClassEntity, ReferenceEntity
 from cognite.neat.utils.utils import get_inheritance_path
 
 from ._base import BaseAnalysis, DataModelingScenario
@@ -126,7 +126,7 @@ class InformationArchitectRulesAnalysis(BaseAnalysis):
         return class_property_pairs
 
     def class_inheritance_path(self, class_: ClassEntity | str, use_reference: bool = False) -> list[ClassEntity]:
-        class_ = class_ if isinstance(class_, ClassEntity) else ClassEntity.from_raw(class_)
+        class_ = class_ if isinstance(class_, ClassEntity) else ClassEntity.load(class_)
         class_parent_pairs = self.class_parent_pairs(use_reference)
         return get_inheritance_path(class_, class_parent_pairs)
 
@@ -328,7 +328,7 @@ class InformationArchitectRulesAnalysis(BaseAnalysis):
         """This is to simplify access to classes through dict."""
         class_dict: dict[str, InformationClass] = {}
         for definition in self.rules.classes:
-            class_dict[definition.class_.suffix] = definition
+            class_dict[str(definition.class_.suffix)] = definition
         return class_dict
 
     def subset_rules(self, desired_classes: set[ClassEntity], use_reference: bool = False) -> InformationRules:
@@ -398,7 +398,7 @@ class InformationArchitectRulesAnalysis(BaseAnalysis):
 
         logging.info(f"Reducing data model to only include the following classes: {possible_classes}")
         for class_ in possible_classes:
-            reduced_data_model["classes"].append(class_as_dict[class_.suffix])
+            reduced_data_model["classes"].append(class_as_dict[str(class_.suffix)])
 
         class_property_pairs = self.classes_with_properties(consider_inheritance=False)
 

cognite/neat/rules/exporters/_rules2excel.py

@@ -205,8 +205,8 @@ class ExcelExporter(BaseExporter[Workbook]):
 
     @classmethod
     def _adjust_column_widths(cls, workbook: Workbook) -> None:
-        for sheet in workbook:
-            sheet = cast(Worksheet, sheet)
+        for sheet_ in workbook:
+            sheet = cast(Worksheet, sheet_)
             for column_cells in sheet.columns:
                 try:
                     max_length = max(len(str(cell.value)) for cell in column_cells if cell.value is not None)

cognite/neat/rules/exporters/_rules2ontology.py

@@ -11,6 +11,8 @@ from rdflib.collection import Collection as GraphCollection
 from cognite.neat.constants import DEFAULT_NAMESPACE as NEAT_NAMESPACE
 from cognite.neat.rules import exceptions
 from cognite.neat.rules.analysis import InformationArchitectRulesAnalysis
+from cognite.neat.rules.models.data_types import DataType
+from cognite.neat.rules.models.entities import ClassEntity, EntityTypes
 from cognite.neat.rules.models.rules import DMSRules
 from cognite.neat.rules.models.rules._information_rules import (
     InformationClass,
@@ -18,7 +20,6 @@ from cognite.neat.rules.models.rules._information_rules import (
     InformationProperty,
     InformationRules,
 )
-from cognite.neat.rules.models.rules._types import XSD_VALUE_TYPE_MAPPINGS, EntityTypes
 from cognite.neat.utils.utils import generate_exception_report, remove_namespace
 
 from ._base import BaseExporter
@@ -114,7 +115,7 @@ class Ontology(OntologyModel):
             ],
             shapes=[
                 SHACLNodeShape.from_rules(
-                    class_dict[class_.suffix],
+                    class_dict[str(class_.suffix)],
                     list(properties.values()),
                     rules.metadata.namespace,
                 )
@@ -249,15 +250,15 @@ class OWLClass(OntologyModel):
             sub_class_of = []
             for parent_class in definition.parent:
                 try:
-                    sub_class_of.append(prefixes[parent_class.prefix][parent_class.suffix])
+                    sub_class_of.append(prefixes[str(parent_class.prefix)][str(parent_class.suffix)])
                 except KeyError:
-                    sub_class_of.append(namespace[parent_class.suffix])
+                    sub_class_of.append(namespace[str(parent_class.suffix)])
         else:
             sub_class_of = None
 
         return cls(
-            id_=namespace[definition.class_.suffix],
-            label=definition.name or definition.class_.suffix,
+            id_=namespace[str(definition.class_.suffix)],
+            label=definition.name or str(definition.class_.suffix),
             comment=definition.description,
             sub_class_of=sub_class_of,
             namespace=namespace,
@@ -324,12 +325,14 @@ class OWLProperty(OntologyModel):
         )
         for definition in definitions:
             owl_property.type_.add(OWL[definition.type_])
-            owl_property.range_.add(
-                XSD[definition.value_type.suffix]
-                if definition.value_type.suffix in XSD_VALUE_TYPE_MAPPINGS
-                else namespace[definition.value_type.suffix]
-            )
-            owl_property.domain.add(namespace[definition.class_.suffix])
+
+            if isinstance(definition.value_type, DataType):
+                owl_property.range_.add(XSD[definition.value_type.xsd])
+            elif isinstance(definition.value_type, ClassEntity):
+                owl_property.range_.add(namespace[str(definition.value_type.suffix)])
+            else:
+                raise ValueError(f"Value type {definition.value_type} is not supported")
+            owl_property.domain.add(namespace[str(definition.class_.suffix)])
             owl_property.label.add(definition.name or definition.property_)
             if definition.description:
                 owl_property.comment.add(definition.description)
@@ -493,12 +496,12 @@ class SHACLNodeShape(OntologyModel):
         cls, class_definition: InformationClass, property_definitions: list[InformationProperty], namespace: Namespace
     ) -> "SHACLNodeShape":
         if class_definition.parent:
-            parent = [namespace[parent.suffix + "Shape"] for parent in class_definition.parent]
+            parent = [namespace[str(parent.suffix) + "Shape"] for parent in class_definition.parent]
         else:
             parent = None
         return cls(
-            id_=namespace[f"{class_definition.class_.suffix}Shape"],
-            target_class=namespace[class_definition.class_.suffix],
+            id_=namespace[f"{class_definition.class_.suffix!s}Shape"],
+            target_class=namespace[str(class_definition.class_.suffix)],
             parent=parent,
             property_shapes=[SHACLPropertyShape.from_property(prop, namespace) for prop in property_definitions],
             namespace=namespace,
@@ -552,8 +555,8 @@ class SHACLPropertyShape(OntologyModel):
             node_kind=SHACL.IRI if definition.type_ == EntityTypes.object_property else SHACL.Literal,
             expected_value_type=(
                 namespace[f"{definition.value_type.suffix}Shape"]
-                if definition.type_ == EntityTypes.object_property
-                else XSD[definition.value_type.suffix]
+                if isinstance(definition.value_type, ClassEntity)
+                else XSD[definition.value_type.xsd]
             ),
             min_count=definition.min_count,
             max_count=(

cognite/neat/rules/exporters/_validation.py

@@ -9,13 +9,13 @@ from cognite.neat.rules.models.rules._types._base import DMS_PROPERTY_ID_COMPLIA
 
 
 @overload
-def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]:
-    ...
+def are_entity_names_dms_compliant(
+    rules: InformationRules, return_report: Literal[True]
+) -> tuple[bool, list[dict]]: ...
 
 
 @overload
-def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[False] = False) -> bool:
-    ...
+def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[False] = False) -> bool: ...
 
 
 def are_entity_names_dms_compliant(
@@ -26,7 +26,7 @@ def are_entity_names_dms_compliant(
     flag: bool = True
     with warnings.catch_warnings(record=True) as validation_warnings:
         for class_ in rules.classes:
-            if not re.match(VIEW_ID_COMPLIANCE_REGEX, class_.class_.suffix):
+            if not re.match(VIEW_ID_COMPLIANCE_REGEX, str(class_.class_.suffix)):
                 warnings.warn(
                     exceptions.EntityIDNotDMSCompliant(
                         "Class", class_.class_.versioned_id, f"[Classes/Class/{class_.class_.versioned_id}]"
@@ -38,7 +38,7 @@ def are_entity_names_dms_compliant(
 
         for row, property_ in enumerate(rules.properties):
             # check class id which would resolve as view/container id
-            if not re.match(VIEW_ID_COMPLIANCE_REGEX, property_.class_.suffix):
+            if not re.match(VIEW_ID_COMPLIANCE_REGEX, str(property_.class_.suffix)):
                 warnings.warn(
                     exceptions.EntityIDNotDMSCompliant(
                         "Class", property_.class_.versioned_id, f"[Properties/Class/{row}]"
@@ -66,13 +66,11 @@ def are_entity_names_dms_compliant(
 
 
 @overload
-def are_properties_redefined(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]:
-    ...
+def are_properties_redefined(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]: ...
 
 
 @overload
-def are_properties_redefined(rules: InformationRules, return_report: Literal[False] = False) -> bool:
-    ...
+def are_properties_redefined(rules: InformationRules, return_report: Literal[False] = False) -> bool: ...
 
 
 def are_properties_redefined(rules: InformationRules, return_report: bool = False) -> bool | tuple[bool, list[dict]]:

cognite/neat/rules/importers/_base.py

@@ -20,14 +20,12 @@ class BaseImporter(ABC):
     """
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     @abstractmethod
     def to_rules(