eclipse-esmf / esmf-sdk-py-aspect-model-loader

Load Aspect Models in Python
https://pypi.org/project/esmf-aspect-model-loader/
Mozilla Public License 2.0
0 stars 4 forks source link

[BUG] Incorrect spelling of library in doc #3

Closed chris-volk closed 1 year ago

chris-volk commented 1 year ago

Describe the bug (User bug report) I am writing to report an issue that I encountered while exploring the Aspect Model Loader for Python library. I followed the instructions provided in the https://openmanufacturingplatform.github.io/sds-documentation/python-sdk-guide/index.html , but I noticed a small mistake that caused some confusion.

Specifically, the library name was incorrectly referred to as " from sds-aspect-meta-model-python import AspectLoader" in the documentation. However, the correct name for the library is " from sds_aspect_meta_model_python import AspectLoader".

This mistake caused some difficulty in setting up the library and using it in my Python script.

Please refer to the attached screenshots for more information.

Thank you for your time and attention to this matter.

Where https://openmanufacturingplatform.github.io/sds-documentation/python-sdk-guide/index.html

Screenshots Aspect_Model Output_With_Updated_Code Python_Script_With_Updated_Code

Additional context Example student.ttl `

@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#>. @prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:2.0.0#>. @prefix bamm-e: <urn:bamm:io.openmanufacturing:entity:2.0.0#>. @prefix unit: <urn:bamm:io.openmanufacturing:unit:2.0.0#>. @prefix rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#. @prefix rdfs: http://www.w3.org/2000/01/rdf-schema#. @prefix xsd: http://www.w3.org/2001/XMLSchema#. @prefix : <urn:bamm:io.openmanufacturing.digitaltwin:1.0.0#>.

:Student a bamm:Aspect; bamm:properties (:name :age :id :enrolled); bamm:operations (); bamm:events (); bamm:preferredName "Student"@en; bamm:description "A student in a school"@en. :name a bamm:Property; bamm:characteristic :StudentName; bamm:preferredName "Name"@en; bamm:description "The name of a student"@en; bamm:exampleValue "Adam". :age a bamm:Property; bamm:characteristic :StudentAge; bamm:preferredName "Age"@en; bamm:description "The age of a student"@en; bamm:exampleValue "20"^^xsd:positiveInteger. :id a bamm:Property; bamm:characteristic :StudentID; bamm:preferredName "ID"@en; bamm:description "The ID of a student"@en; bamm:exampleValue "1241"^^xsd:positiveInteger. :enrolled a bamm:Property; bamm:characteristic :StudentEnrolled; bamm:preferredName "Enrolled"@en; bamm:description "Indicates whether a student is enrolled in a school"@en; bamm:exampleValue "True"^^xsd:boolean. :StudentAge a bamm:Characteristic; bamm:dataType xsd:positiveInteger; bamm:preferredName "Age"@en; bamm:description "Age of the Student"@en. :StudentID a bamm:Characteristic; bamm:dataType xsd:positiveInteger; bamm:preferredName "ID"@en; bamm:description "ID of the Student"@en. :StudentName a bamm:Characteristic; bamm:dataType xsd:string; bamm:preferredName "Name"@en; bamm:description "Name of the Student"@en. :StudentEnrolled a bamm:Characteristic; bamm:dataType xsd:boolean; bamm:preferredName "Enrolled"@en; bamm:description "Student Enrolled or not"@en.

`