Skip to content

Commit 96dc3cb

Browse files
ThijssThijss
committed
merge main branch
2 parents 82d52f9 + 4c3f19d commit 96dc3cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1463
-572
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,6 @@ PYPI_VERSION
5555
build/
5656
wheelhouse/
5757
_build/
58+
59+
# Jupyter Notebook
60+
.ipynb_checkpoints

‎CITATION.cff‎

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
# SPDX-License-Identifier: MPL-2.0
44

55
cff-version: 1.2.0
6-
message: "If you are using Power Grid Model in your research work, please consider citing our library as below."
6+
message: "If you are using Power Grid Model DS in your research work, please consider citing our library as below."
77

88
title: "PowerGridModel/power-grid-model-ds"
99
url: "https://github.com/PowerGridModel/power-grid-model-ds"
10+
doi: "10.5281/zenodo.14825565"
1011
license: "MPL-2.0"
1112
authors:
1213
- family-names: "Schouten"
@@ -40,6 +41,7 @@ references:
4041
given-names: "Yu"
4142
email: "[email protected]"
4243
affiliation: "Alliander"
44+
orcid: "https://orcid.org/0000-0001-5889-0067"
4345
- family-names: "Salemink"
4446
given-names: "Peter"
4547
email: "[email protected]"
@@ -49,12 +51,14 @@ references:
4951
given-names: "Werner"
5052
email: [email protected]
5153
affiliation: "Alliander"
54+
orcid: "https://orcid.org/0000-0002-4058-2581"
5255
- family-names: "Bharambe"
5356
given-names: "Nitish"
5457
email: "[email protected]"
5558
affiliation: "Alliander"
59+
orcid: "https://orcid.org/0009-0007-9694-6077"
5660
- family-names: "Govers"
57-
given-names: "Martinus"
61+
given-names: "Martinus G.H."
5862
email: "[email protected]"
5963
affiliation: "Alliander"
6064
orcid: "https://orcid.org/0009-0008-6890-8353"
@@ -69,10 +73,16 @@ references:
6973
given-names: "Zhen"
7074
email: "[email protected]"
7175
affiliation: "Alliander"
76+
orcid: "https://orcid.org/0000-0003-4317-6455"
7277
- family-names: "Guo"
73-
given-names: "Jerry"
74-
email: "Jerry.Jinfeng.Guo@Alliander.com"
78+
given-names: "Jerry Jinfeng"
79+
email: "Jerry.Jinfeng.Guo@hotmail.com"
7580
affiliation: "Alliander"
81+
orcid: "https://orcid.org/0000-0002-8065-4084"
82+
- family-names: "Figueroa Manrique"
83+
given-names: "Santiago"
84+
email: "[email protected]"
85+
affiliation: "Alliander"
7686
- family-names: "Jagutis"
7787
given-names: "Laurynas"
7888
email: "[email protected]"
@@ -86,10 +96,6 @@ references:
8696
given-names: "Marc"
8797
email: "[email protected]"
8898
affiliation: "Alliander"
89-
- family-names: "Figueroa Manrique"
90-
given-names: "Santiago"
91-
email: "[email protected]"
92-
affiliation: "Alliander"
9399
- name: "Contributors to the LF Energy project Power Grid Model"
94100

95101
- title: "Power grid model: A high-performance distribution grid calculation library"
@@ -99,6 +105,7 @@ references:
99105
given-names: "Yu"
100106
email: [email protected]
101107
affiliation: "Alliander"
108+
orcid: "https://orcid.org/0000-0001-5889-0067"
102109
- family-names: "Salemink"
103110
given-names: "Peter"
104111
email: [email protected]
@@ -109,11 +116,13 @@ references:
109116
given-names: "Nitish"
110117
email: [email protected]
111118
affiliation: "Alliander"
119+
orcid: "https://orcid.org/0009-0007-9694-6077"
112120
- family-names: "Westering"
113121
name-particle: "van"
114122
given-names: "Werner"
115123
email: [email protected]
116124
affiliation: "Alliander"
125+
orcid: "https://orcid.org/0000-0002-4058-2581"
117126
conference:
118127
name: "CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution"
119128
type: conference-paper
@@ -131,6 +140,7 @@ references:
131140
given-names: "Yu"
132141
email: "[email protected]"
133142
affiliation: "Alliander"
143+
orcid: "https://orcid.org/0000-0001-5889-0067"
134144
- family-names: "Salemink"
135145
given-names: "Peter"
136146
email: "[email protected]"
@@ -139,8 +149,9 @@ references:
139149
given-names: "Nitish"
140150
email: "[email protected]"
141151
affiliation: "Alliander"
152+
orcid: "https://orcid.org/0009-0007-9694-6077"
142153
- family-names: "Govers"
143-
given-names: "Martinus"
154+
given-names: "Martinus G.H."
144155
email: "[email protected]"
145156
affiliation: "Alliander"
146157
orcid: "https://orcid.org/0009-0008-6890-8353"
@@ -155,9 +166,15 @@ references:
155166
given-names: "Zhen"
156167
email: "[email protected]"
157168
affiliation: "Alliander"
169+
orcid: "https://orcid.org/0000-0003-4317-6455"
158170
- family-names: "Guo"
159-
given-names: "Jerry"
160-
email: "[email protected]"
171+
given-names: "Jerry Jinfeng"
172+
email: "[email protected]"
173+
affiliation: "Alliander"
174+
orcid: "https://orcid.org/0000-0002-8065-4084"
175+
- family-names: "Figueroa Manrique"
176+
given-names: "Santiago"
177+
email: "[email protected]"
161178
affiliation: "Alliander"
162179
- family-names: "Jagutis"
163180
given-names: "Laurynas"
@@ -167,8 +184,4 @@ references:
167184
given-names: "Chenguang"
168185
email: "[email protected]"
169186
affiliation: "Alliander"
170-
- family-names: "Figueroa Manrique"
171-
given-names: "Santiago"
172-
email: "[email protected]"
173-
affiliation: "Alliander"
174187
- name: "Contributors to the LF Energy project Power Grid Model"

‎README.md‎

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@ SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridm
44
SPDX-License-Identifier: MPL-2.0
55
-->
66

7+
[![PyPI version](https://badge.fury.io/py/power-grid-model-ds.svg?no-cache)](https://badge.fury.io/py/power-grid-model-ds)
8+
[![License: MIT](https://img.shields.io/badge/License-MPL2.0-informational.svg)](https://github.com/PowerGridModel/power-grid-model-ds/blob/main/LICENSE)
9+
[![Downloads](https://static.pepy.tech/badge/power-grid-model-ds)](https://pepy.tech/project/power-grid-model-ds)
10+
[![Downloads](https://static.pepy.tech/badge/power-grid-model-ds/month)](https://pepy.tech/project/power-grid-model-ds)
11+
12+
[![Build and Test Python](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/build-test-and-sonar.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/build-test-and-sonar.yml)
13+
[![Check Code Quality](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/check-code-quality.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/check-code-quality.yml)
14+
[![REUSE Compliance Check](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/reuse-compliance.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/reuse-compliance.yml)
15+
[![docs](https://readthedocs.org/projects/power-grid-model-ds/badge/)](https://power-grid-model-ds.readthedocs.io/en/stable/)
16+
17+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
18+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=coverage)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
19+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
20+
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
21+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
22+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
23+
24+
[![Nightly build](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/nightly.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/nightly.yml)
25+
26+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825565.svg)](https://zenodo.org/record/14825565)
27+
728
[![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)
829

930
# Power Grid Model Data Science (DS)
@@ -30,6 +51,7 @@ See the [power-grid-model-ds documentation](https://power-grid-model-ds.readthed
3051
```
3152
pip install power-grid-model-ds
3253
```
54+
3355
## License
3456

3557
This project is licensed under the Mozilla Public License, version 2.0 - see [LICENSE](https://github.com/PowerGridModel/power-grid-model-ds/blob/main/LICENSE) for details.
@@ -46,7 +68,40 @@ The concerning license files can be found in the [LICENSES](https://github.com/P
4668
Please read [CODE_OF_CONDUCT](https://github.com/PowerGridModel/.github/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/PowerGridModel/.github/blob/main/CONTRIBUTING.md) for details on the process
4769
for submitting pull requests to us.
4870

71+
## Citations
72+
73+
If you are using Power Grid Model DS in your research work, please consider citing our library using the following references.
74+
75+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825565.svg)](https://zenodo.org/record/14825565)
76+
77+
```bibtex
78+
@software{Schouten_PowerGridModel_power-grid-model-ds,
79+
author = {Schouten, Jaap and Baaijen, Thijs and Koppen, Vincent and van der Voort, Sven and {Contributors to the LF Energy project Power Grid Model}},
80+
doi = {10.5281/zenodo.14825565},
81+
license = {MPL-2.0},
82+
title = {{PowerGridModel/power-grid-model-ds}},
83+
url = {https://github.com/PowerGridModel/power-grid-model-ds}
84+
}
85+
@software{Xiang_PowerGridModel_power-grid-model,
86+
author = {Xiang, Yu and Salemink, Peter and van Westering, Werner and Bharambe, Nitish and Govers, Martinus G.H. and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry Jinfeng and Figueroa Manrique, Santiago and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},
87+
doi = {10.5281/zenodo.8054429},
88+
license = {MPL-2.0},
89+
title = {{PowerGridModel/power-grid-model}},
90+
url = {https://github.com/PowerGridModel/power-grid-model}
91+
}
92+
@inproceedings{Xiang2023,
93+
author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner},
94+
booktitle={27th International Conference on Electricity Distribution (CIRED 2023)},
95+
title={Power grid model: a high-performance distribution grid calculation library},
96+
year={2023},
97+
volume={2023},
98+
number={},
99+
pages={1089-1093},
100+
keywords={},
101+
doi={10.1049/icp.2023.0633}
102+
}
103+
```
104+
49105
## Contact
50106

51107
Please read [SUPPORT](https://github.com/PowerGridModel/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the Power Grid Model project.
52-

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.0
1+
1.2

‎docs/Makefile‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
# SPDX-License-Identifier: MPL-2.0
44

55
# Minimal makefile for Sphinx documentation
6-
#
76

87
# You can set these variables from the command line, and also
98
# from the environment for the first two.
109
SPHINXOPTS ?=
1110
SPHINXBUILD ?= sphinx-build
12-
SOURCEDIR = source
11+
SOURCEDIR = .
1312
BUILDDIR = _build
1413

1514
# Put it first so that "make" without argument is like "make help".

0 commit comments

Comments
 (0)