azure / opendigitaltwins-energygrid

DTDL based ontology for Energy Grid

Digital Twins Definition Language (DTDL) ontology for Energy Grid

Domain ontologies are the foundational components to develop global solutions with industry standards. The Azure IoT engineering team has been collaborating with customers, domain experts, and industry-standard organizations to develop DTDL ontologies by leveraging the existing industry ontologies and best practices. Earlier, we published the DTDL ontologies for smart buildings based on RealEstateCore, and for smart cities based on ETSI NGSI-LD. Today, we are releasing the energy grid ontology adapted from Common Information Model (CIM), a global standard for energy grid assets management, power system operations modeling and physical energy commodity market. The CIM-based DTDL ontology provides contextual understanding of data by identifying the properties of various grid entities and the relationships among them. Power & Utilities customers and partners can leverage as well as extend this open-source repository for their solutions and contribute their learnings to the repository for others to benefit from.

The CIM organizes entities into distinct packages. In this first iteration, we have included core, wire, and generation packages, and prosumer-related entities from metering, customer, and Distributed Energy Resource (DER) packages. We have selected them based on the implemented and in-progress solutions, and on the collaborative decision of the extended team members of Agder Energi, Statnett, Sirus, FiWare, and Azure IoT.

• Core Package contains the PowerSystemResource, ConductingEquipmen, and common collections of those entities shared by all applications. Most of the other packages have associations and generalizations that depend on the core package.
• Wire Package is an extension to the Core that provides model information on the electrical characteristics of transmission and distribution networks. This package is used by network applications, such as state estimation, load flow, and optimal power flow.
• Generation Package has information for unit commitment and economic dispatch of hydro and thermal generating units, load forecasting, automatic generation control, and unit modeling for training simulation. Last but not least – prosumer – we included various entities related to consumer and DER in the prosumer folder. For examples, EquivalentLoad, UsagePoints, and MeterReading.

If you need additional entities before the next iteration, please contact us. If you already have DTDL grid entities feel free to contribute them to the repo.

How To Use

Using these models you can now build Azure Digital Twins based solution and bring it to life in a live execution environment.

You can use Azure Digital Twins Explorer to create a sample easily: upload models, instantiate entities in a twins graph, visualize the graph and run queries against the graph.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Modeling guidelines

Before creating new entities, check if they exist already in the repo. You can look under each folder.

To learn how to adopt the ontology for your project, refer to How to use the ontology.

Syntax

• Use English terms, preferably American English.
• Use camel case syntax for attribute names (camelcase).
• Entity Type names must start with a Capital letter, for example: Substation.
• Use names and not verbs for Attributes of type Property, for example: nominalVoltage, EquipmentContainer.
• Use verbs for Relationship and optional an object, for example: locatedAt, partOf.

Data Types

DTDL provides a full set of primitive data types, along with support for a variety of complex schemas.

Validation

Use the DTDL Validator tool to validate the model document to make sure the DTDL is valid.

Resources

• Azure Digital Twins product page
• Azure Digital Twins documentation
• Azure Digital Twins Tech Deep Dive
• Digital Twins Definition Language specification
• DTDL Ontologies
• ADT Explorer
• Azure Digital Twins Model Uploader

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

opendigitaltwins-energygrid's Issues

Ontology contains multiple model files for 'dtmi:digitaltwins:ngsi_ld:cim:energy:GeneratingUnit;1'

Just tried to upload the ontology with Model Uploader. ModelUploader has detected two model files that both define the same model interface 'dtmi:digitaltwins:ngsi_ld:cim:energy:GeneratingUnit;1'

First at location: Generation/GeneratingUnit.json
Second at location: Prosumers/Distributed Energy Resource/GeneratingUnit/GeneratingUnit.json

One of them should be removed.

Ontology can't be uploaded with ModelUploader

Just tried to upload the complete ontology with Model Uploader. Unfortunately the '.vscode' subfolder in the 'Ontology' folder, and its *.json files inside, will cause a crash of the ModelUploader.

This can be fixed by removing the '.vscode' subfolder in the 'Ontology' folder or by fixing the ModelUploader tool. I'll work on a PR for that.

Enhancment ideas

1. Mark the version of CIM in schema - example: https://github.com/Haigutus/USVDM/tree/master/Tools/RDF_PARSER/entsoe_v2.4.15_2014-08-07_DTDL_V2
2. Add import script for CIM/XML - example:
   https://github.com/Haigutus/USVDM/blob/master/Tools/RDF_PARSER/Azure_DT_conection.py
3. Add export script for CIM/XML

Other findings from experimenting with azure DT:
https://github.com/Haigutus/USVDM/wiki/AzureDigitalTwin_example

Float Schema for String

I had a look on IdentifiedObject and found that the attributes were defined as "Float" schema. They should all be defined as String.https://github.com/Azure/opendigitaltwins-energygrid/blob/main/Ontology/Core/IdentifiedObject.json

ACTION REQUIRED: Microsoft needs this private repository to complete compliance info

There are open compliance tasks that need to be reviewed for your opendigitaltwins-energygrid repo.

Action required: 4 compliance tasks

To bring this repository to the standard required for 2021, we require administrators of this and all Microsoft GitHub repositories to complete a small set of tasks within the next 60 days. This is critical work to ensure the compliance and security of your Azure GitHub organization.

Please take a few minutes to complete the tasks at: https://repos.opensource.microsoft.com/orgs/Azure/repos/opendigitaltwins-energygrid/compliance

• The GitHub AE (GitHub inside Microsoft) migration survey has not been completed for this private repository
• No Service Tree mapping has been set for this repo. If this team does not use Service Tree, they can also opt-out of providing Service Tree data in the Compliance tab.
• No repository maintainers are set. The Open Source Maintainers are the decision-makers and actionable owners of the repository, irrespective of administrator permission grants on GitHub.
• Classification of the repository as production/non-production is missing in the Compliance tab.

You can close this work item once you have completed the compliance tasks, or it will automatically close within a day of taking action.

If you no longer need this repository, it might be quickest to delete the repo, too.

GitHub inside Microsoft program information

More information about GitHub inside Microsoft and the new GitHub AE product can be found at https://aka.ms/gim or by contacting [email protected]

FYI: current admins at Microsoft include @miriambrus, @op-ravi, @alinamstanciu