CIMSPARQL Query CIM data using sparql
This Python package provides functionality for reading cim data from triple stores such as GraphDB, BlazeGraph or Rdf4j into Python memory as pandas dataframes.
The package provides a set of predefined functions/queries to load CIM data such as generator, demand or branch data, though the user can easily define their own queries.
Usage
Load data using predefined functions/queries
>>> from cimsparql.graphdb import ServiceConfig
>>> from cimsparql.model import get_single_client_model
>>> model = get_single_client_model(ServiceConfig(limit=3))
>>> ac_lines = model.ac_lines()
>>> print(ac_lines[['name', 'x', 'r', 'bch']])
name x r bch
0 <branch 1> 1.9900 0.8800 0.000010
1 <branch 2> 1.9900 0.8800 0.000010
2 <branch 3> 0.3514 0.1733 0.000198
In the example above the client will query repo "" in the default server GraphDB for AC line values.
Inspect/view predefined queries
See the sparql templates folder (cimsparql/sparql) to the query used.
Load data using user specified queries
>>> from string import Template
>>> query = 'PREFIX cim:<${cim}>\nPREFIX rdf: <${rdf}>\nSELECT ?mrid where {?mrid rdf:type cim:ACLineSegment}'
>>> query_result = model.get_table_and_convert(model.template_to_query(Template(query)))
>>> print(query_result)
Prefix and namespace
Available namespace for current graphdb client (gdbc in the examples above),
which can be used in queries (such as rdf and cim) can by found by
>>> print(model.prefixes)
{'wgs': 'http://www.w3.org/2003/01/geo/wgs84_pos#',
'rdf': 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
'owl': 'http://www.w3.org/2002/07/owl#',
'cim': 'http://iec.ch/TC57/2010/CIM-schema-cim15#',
'gn': 'http://www.geonames.org/ontology#',
'xsd': 'http://www.w3.org/2001/XMLSchema#',
'rdfs': 'http://www.w3.org/2000/01/rdf-schema#',
'SN': 'http://www.statnett.no/CIM-schema-cim15-extension#',
'ALG': 'http://www.alstom.com/grid/CIM-schema-cim15-extension#'}
Running Tests Against Docker Databases
Tests can be run against RDF4J databases if a container with the correct images are available.
docker pull eclipse/rdf4j-workbench
Launch one or both containers and specify the following environment variables
RDF4J_URL = "localhost:8080/rdf4j-server"
Note 1: The port numbers may differ depending on your local Docker configurations. Note 2: You don't have to install RDF4J or BlazeGraph. Tests requiring these will be skipped in case they are not available. They will in any case be run in the CI pipeline on GitHub (where both always are available).
Test models
- micro:
MicroGrid/Type1_T1/CGMES_v2.4.15_MicroGridTestConfiguration_T1_NL_Complete_v2 - small: See separate documentation
Rest APIs
CimSparql mainly uses SparqlWrapper to communicate with the databases. However, there are certain operations which are performed
directly via REST calls. Since there are small differences between different APIs you may have to specify which API you are using.
This can be done when initializing the ServiceCfg class or by specifying the SPARQL_REST_API environment variable. Currently,
RDF4J and blazegraph is supported (if not given RDF4J is default).
export SPARQL_REST_API=RDF4J # To use RDF4J
export SPARQL_REST_API=BLAZEGRAPH # To use BlazeGraph
Contributing
Contributions are always welcome and encouraged! Whether it's reporting a bug, suggesting an enhancement, or submitting a pull request, your input helps improve the project.
Development
Dependencies are managed through uv, install with uv sync.
It's recommended to install the pre-commit hooks so checks are run automatically on every commit.
After installing pre-commit itself, install the hooks with pre-commit install.
Checks are normally only run on modified files when committing, but you can run all checks on all files with
pre-commit run --all.
Metadata
Release files for cimsparql 9.16.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cimsparql-9.16.0.tar.gz | 644.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cimsparql-9.16.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 714.0 kB
Release files / cimsparql-9.16.0.tar.gz
| Download URL | cimsparql-9.16.0.tar.gz |
|---|---|
| Size | 644.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eae0155748f60833aec9595fd2c1b35abec5ea64fcf3da0fa21fb3adba14acfe
|
|
BLAKE2b-256 checksum How to use checksums |
c0772578c2947107513cc679ca710f53cdb4b9f0c20223c941606349dd2f5283
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / cimsparql-9.16.0-py3-none-any.whl
| Download URL | cimsparql-9.16.0-py3-none-any.whl |
|---|---|
| Size | 69.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25d0d93d2e5dfe4cb8a0f5399212bc6cb4c9e3da5cf61b23621d805e51cd3919
|
|
BLAKE2b-256 checksum How to use checksums |
b1ec48fdb9cf70e803bbe9713015dc642c8f2a7b47608192cb4d959909926510
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
