CIMantic Graphs Library Documentation

CIMantic Graphs is an open-source library for creating, parsing, and editing CIM power system models using in-memory knowledge graphs to reduce the burden and learning curve associated with using the Common Information Model.

Key features:

• Single API method to obtain data for any CIM class. No more custom database queries.

• Single API method to obtain data for EMS node-breaker transmission models, bus-branch planning models, and distribution feeder models.

• Singe API method for both centralized and distributed architectures.

• Support for multiple databases and query languages with no changes to upper-level graph data or API calls. Only need to change host/port specified in ConnectionParameters data object.

• Ability to create CIM models “from scratch”.

• Open-source data engineering tool for management of CIM models.

• Knowledge graph approach based on semantic understanding of CIM.

• Object-oriented data structure with enforcement of CIM Schema.

• Data profiles generated directly from Enterprise Architect UML

• Support for custom profiles using CIMTool.

• Support for direct creation / editing / parsing of CIM XML, JSON-LD.

• API support for centralized/distributed transmission + distribution models.

To install CIMantic Graphs clone the github repository or use pip install: pip install cim-graph

Overview

• Overview & Quick Start
  • Table of Contents:
  • CIMantic Graphs Structure
  • Importing CIMantic Graphs
  • Specifying Environment Variables
  • Connecting to the Data Source
  • Creating a Container and Graph Model
  • Automated Database Queries
  • Traversing the Knowledge Graph
  • Utils Shortcuts
• Installation
  • Prerequisites
  • Installating from PyPi
  • Installing from Source
• CIM-Graph Library Structure
• Contribution Guidelines
  • Table of Contents
  • Getting Started
  • How to Contribute
  • Coding Standards
  • Review Process
  • Code of Conduct

CIM Profiles

• Overview of CIM Profiles
• Building Profiles with CIMTool
  • CIMTool Builder
• Using CIM Objects

Databases

• Databases Overview
• Environment Variables
  • CIMG_CIM_PROFILE
  • CIMG_IEC61960_301
  • Connection Parameters (Deprecated)
• Blazegraph Database
  • About Triplestore Databases
  • Blazegraph Environment Variables
  • Blazegraph Database Connection
  • API Reference
  • UML Sequence Diagrams
  • Blazegraph Connection Parameters (Deprecated)
• Neo4j Database
• Graph-DB Database
• MySQL JSON-LD Database
• GridAPPS-D Platform Connection
  • Connection Parameters
• XML File Parser

Graph Models

• GraphModel Overview
  • Intro to Knowledge Graphs
  • Intro to Typed Property Graphs
  • GraphModel Base Class
  • API Reference
  • UML Diagrams
• Distribution Feeder Modeling
  • Distribution Feeders in CIM
  • FeederModel Class
  • Loading a FeederModel from an XML File
  • Loading a FeederModel from a Database
  • FeederModel.graph
• Node Breaker Models
  • Transmission Network Models in CIM
  • Loading a FeederModel from an XML File
  • Modifying Files
  • Saving to a File
  • Advanced Concepts - Distributed Modeling
• Bus-Branch Transmission Modeling
  • Creating a BusBranchModel
• Distributed Topological Areas

Utils Shortcuts

• File Writers
• Get All Data Shortcuts
• Mermaid Diagramming