cimpy

Import and export CGMES / CIM IEC-61970 files in the XML/RDF format

https://github.com/sogno-platform/cimpy

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    6 of 11 committers (54.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary

Keywords

cim cim-export cim-import iec61970 python
Last synced: 6 months ago · JSON representation

Repository

Import and export CGMES / CIM IEC-61970 files in the XML/RDF format

Basic Info
  • Host: GitHub
  • Owner: sogno-platform
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage: https://sogno.energy/cimpy/
  • Size: 2.15 MB
Statistics
  • Stars: 63
  • Watchers: 3
  • Forks: 23
  • Open Issues: 5
  • Releases: 1
Topics
cim cim-export cim-import iec61970 python
Created about 6 years ago · Last pushed 12 months ago
Metadata Files
Readme License

README.md

CIMpy

The CIMpy package enables the import, modification and export of grid data in the format of XML/RDF documents based on the Common Information Model (CIM) specified by the IEC61970 standard.

The processing of grid data is based on CIM compatible Python classes. The codebase for the CIM compatible Python classes was generated in an automated way. A separate tool allows for an easy adaption of CIMpy and its underlying codebase.

The focus of CIMpy is on the support of the Common Grid Model Exchange Standard (CGMES) specified by the European Network of Transmission System Operators for Electricity (ENTSO-E). However, the CIMpy package can readily support further as well as new CIM versions if required.

Documentation

CIMpy's documentation you can find here. The documentation provides instructions on CIMpy's installation, getting started examples and the possibility to browse through the supported CIM class codebases.

Development

Developer Installation

bash git clone https://github.com/sogno-platform/cimpy.git cd cimpy pip install -e .[dev]

Run pre-commit checks manually:

bash pre-commit run --all-files

Install pre-commit hook to run it automatically:

bash pre-commit install

License

This project is released under the terms of the Apache License 2.0.

Publications

If you are using CIMpy for your research, please cite the following paper in your publications:

Dinkelbach, J., Razik, L., Mirz, M., Benigni, A., Monti, A.: Template-based generation of programming language specific code for smart grid modelling compliant with CIM and CGMES. J. Eng. 2023, 1-13 (2022). https://doi.org/10.1049/tje2.12208

Owner

  • Name: SOGNO
  • Login: sogno-platform
  • Kind: organization

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 4
  • Watch event: 8
  • Delete event: 7
  • Member event: 2
  • Issue comment event: 8
  • Push event: 8
  • Pull request event: 10
  • Pull request review event: 2
  • Fork event: 3
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 4
  • Watch event: 8
  • Delete event: 7
  • Member event: 2
  • Issue comment event: 8
  • Push event: 8
  • Pull request event: 10
  • Pull request review event: 2
  • Fork event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 198
  • Total Committers: 11
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.747
Past Year
  • Commits: 30
  • Committers: 2
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.133
Top Committers
Name Email Commits
Philipp Reuber p****r@r****e 50
Jonathan Klimt j****t@r****e 38
Jan Dinkelbach j****h@e****e 34
Thomas Günther t****m@t****e 26
Steffen Vogel s****l@o****m 21
Richard Marston r****n@e****e 13
Markus Mirz m****z@r****e 11
Moraga Martin m****a@r****e 2
Tobias Schmocker t****r@a****m 1
SimonGrimmACS 8****S 1
Martin Moraga m****1@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 29
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 10
  • Total pull request authors: 11
  • Average comments per issue: 2.14
  • Average comments per pull request: 1.59
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • m-mirz (4)
  • stv0g (3)
  • martinmoraga (2)
  • isavelli (1)
  • schmocker (1)
  • zhizhuaa (1)
  • SystemsPurge (1)
  • dinkelbachjan (1)
  • AJNeufeld (1)
  • AnkurArohi (1)
Pull Request Authors
  • stv0g (8)
  • m-mirz (6)
  • martinmoraga (5)
  • tom-hg57 (4)
  • SimonGrimmACS (4)
  • richardmarston (3)
  • dinkelbachjan (2)
  • ThomasSchwierz (2)
  • schmocker (1)
  • jounathaen (1)
  • iripiri (1)
Top Labels
Issue Labels
bug (3) enhancement (1)
Pull Request Labels
bug (6) documentation (2) enhancement (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,765 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 3
    (may contain duplicates)
  • Total versions: 8
  • Total maintainers: 4
pypi.org: cimpy

Python package for import, modification and export of CIM grid data

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 1,765 Last month
Rankings
Dependent repos count: 9.0%
Dependent packages count: 10.0%
Average: 12.7%
Downloads: 19.0%
Maintainers (4)
Last synced: 6 months ago
github actions: sogno-platform/cimpy

We are going to build the documentation!

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 0.0%
Stargazers count: 6.4%
Forks count: 8.0%
Average: 14.3%
Dependent repos count: 42.9%
Last synced: 6 months ago

Dependencies

setup.py pypi
  • chevron *
  • lxml *
  • xmltodict *
.github/workflows/pytest.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/workflow.yaml actions
  • ./ * composite
  • actions/checkout v3 composite
  • finnp/create-file-action master composite
  • s0/git-publish-subdir-action develop composite
action.yaml actions
  • Dockerfile * docker
Dockerfile docker
  • fedora 29 build