GridAPPS-D Platform Connection

GridAPPS-D™ is an open-source platform that accelerates development and deployment of portable applications for advanced distribution management and operations. It is built in a linux environment using Docker, which allows large software packages to be distributed as containers. Its purpose is to reduce the time and cost to integrate advanced functionality into distribution operations, to create a more reliable and resilient grid.

The GridAPPS-D source code is publically available from the GridAPPS-D GitHub. The GridAPPS-D™ project is sponsored by the U.S. Department of Energy Office of Electricity and receives ongoing updates from a team of core developers at PNNL. Documentation for the platform and API is available on the GridAPPS-D Training ReadTheDocs.

Connection Parameters

GridAPPS-D uses Java Token Authentication for user authentication based on a combination of IP address, port, username, and password. The set of default username and passwords are available in the GOSS Security Config File.

The CIM-Graph ConnectionParameters class is used to specify the configuration used to connect to the platform and access the data contained in the platform, with the following default values:

  • cim_profile: Use cimhub_2023 for GridAPPS-D releases v2025.01.0 and later. Use rc4_2021 for releases v2024.09.0 and earlier.

  • iec61970_301: CIM serialization format. Use 8 for GridAPPS-D releases v2025.01.0 and later. Use 7 for releases v2024.09.0 and earlier.

  • host: IP address for the platform, default is localhost. Remote servers should use the IP address of the server.

  • port: IP port for the platform message bus, default is 61613.

  • username: Username from GOSS security config, default is app_user.

  • password: Password from GOSS security config, default is 1234App.

  • database: GridAPPS-D API to be used. Currently only powergridmodel API is supported.

  • url: URL of the internal database. If running inside a docker container, this needs to be updated

To connect with the default parameters, only the cim_profile and iec61970_301 versions need to be specified:

[ ]:



[ ]:

from cimgraph.databases import ConnectionParameters
params = ConnectionParameters(host= "localhost", port="61613",
                             username="app_user", password="1234App",
                             cim_profile='rc4_2021', namespace="http://iec.ch/TC57/CIM100#")

---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
Cell In[3], line 1
----> 1 params = ConnectionParameters(host= "localhost", port="61613",
      2                              username="app_user", password="1234App",
      3                              cim_profile='rc4_2021', namespace="http://iec.ch/TC57/CIM100#")

NameError: name 'ConnectionParameters' is not defined

[ ]:

# Import class from cimgraph databases module
from cimgraph.databases import GridappsdConnection
# Create connection parameters

# Create platform connection object
gapps = GridAPPSDConnection(params)

---------------------------------------------------------------------------
ImportError                               Traceback (most recent call last)
Cell In[2], line 2
      1 # Import class from cimgraph databases module
----> 2 from cimgraph.databases import GridAPPSDConnection
      3 # Create connection parameters
      4 params = ConnectionParameters(host= "localhost", port="61613",
      5                              username="app_user", password="1234App",
      6                              cim_profile='rc4_2021', namespace="http://iec.ch/TC57/CIM100#")

ImportError: cannot import name 'GridAPPSDConnection' from 'cimgraph.databases' (/home/ande188/CIM-Graph/cimgraph/databases/__init__.py)

[ ]: