diff --git a/CITATION.cff b/CITATION.cff index 37f2ad6..f8f4545 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -7,6 +7,7 @@ message: "If you are using Power Grid Model DS in your research work, please con title: "PowerGridModel/power-grid-model-ds" url: "https://github.com/PowerGridModel/power-grid-model-ds" +doi: "10.5281/zenodo.14825565" license: "MPL-2.0" authors: - family-names: "Schouten" @@ -78,6 +79,10 @@ references: email: "Jerry.Jinfeng.Guo@hotmail.com" affiliation: "Alliander" orcid: "https://orcid.org/0000-0002-8065-4084" + - family-names: "Figueroa Manrique" + given-names: "Santiago" + email: "Santiago.Figueroa.Manrique@Alliander.com" + affiliation: "Alliander" - family-names: "Jagutis" given-names: "Laurynas" email: "Laurynas.Jagutis@Alliander.com" @@ -91,10 +96,6 @@ references: given-names: "Marc" email: "Marc.van.Raalte@Alliander.com" affiliation: "Alliander" - - family-names: "Figueroa Manrique" - given-names: "Santiago" - email: "Santiago.Figueroa.Manrique@Alliander.com" - affiliation: "Alliander" - name: "Contributors to the LF Energy project Power Grid Model" - title: "Power grid model: A high-performance distribution grid calculation library" @@ -171,6 +172,10 @@ references: email: "Jerry.Jinfeng.Guo@hotmail.com" affiliation: "Alliander" orcid: "https://orcid.org/0000-0002-8065-4084" + - family-names: "Figueroa Manrique" + given-names: "Santiago" + email: "Santiago.Figueroa.Manrique@Alliander.com" + affiliation: "Alliander" - family-names: "Jagutis" given-names: "Laurynas" email: "Laurynas.Jagutis@Alliander.com" @@ -179,8 +184,4 @@ references: given-names: "Chenguang" email: "Chenguang.Wang@Alliander.com" affiliation: "Alliander" - - family-names: "Figueroa Manrique" - given-names: "Santiago" - email: "Santiago.Figueroa.Manrique@Alliander.com" - affiliation: "Alliander" - name: "Contributors to the LF Energy project Power Grid Model" diff --git a/README.md b/README.md index 4168f5f..1680f56 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,27 @@ SPDX-FileCopyrightText: Contributors to the Power Grid Model project +[![PyPI version](https://badge.fury.io/py/power-grid-model-ds.svg?no-cache)](https://badge.fury.io/py/power-grid-model-ds) +[![License: MIT](https://img.shields.io/badge/License-MPL2.0-informational.svg)](https://github.com/PowerGridModel/power-grid-model-ds/blob/main/LICENSE) +[![Downloads](https://static.pepy.tech/badge/power-grid-model-ds)](https://pepy.tech/project/power-grid-model-ds) +[![Downloads](https://static.pepy.tech/badge/power-grid-model-ds/month)](https://pepy.tech/project/power-grid-model-ds) + +[![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) +[![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) +[![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) +[![docs](https://readthedocs.org/projects/power-grid-model-ds/badge/)](https://power-grid-model-ds.readthedocs.io/en/stable/) + +[![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) +[![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) +[![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) +[![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) +[![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) +[![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) + +[![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) + +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825565.svg)](https://zenodo.org/record/14825565) + [![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#) # Power Grid Model Data Science (DS) @@ -30,6 +51,7 @@ See the [power-grid-model-ds documentation](https://power-grid-model-ds.readthed ``` pip install power-grid-model-ds ``` + ## License 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 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 for submitting pull requests to us. +## Citations + +If you are using Power Grid Model DS in your research work, please consider citing our library using the following references. + +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825565.svg)](https://zenodo.org/record/14825565) + +```bibtex +@software{Schouten_PowerGridModel_power-grid-model-ds, + author = {Schouten, Jaap and Baaijen, Thijs and Koppen, Vincent and van der Voort, Sven and {Contributors to the LF Energy project Power Grid Model}}, + doi = {10.5281/zenodo.14825565}, + license = {MPL-2.0}, + title = {{PowerGridModel/power-grid-model-ds}}, + url = {https://github.com/PowerGridModel/power-grid-model-ds} +} +@software{Xiang_PowerGridModel_power-grid-model, + 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}}, + doi = {10.5281/zenodo.8054429}, + license = {MPL-2.0}, + title = {{PowerGridModel/power-grid-model}}, + url = {https://github.com/PowerGridModel/power-grid-model} +} +@inproceedings{Xiang2023, + author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner}, + booktitle={27th International Conference on Electricity Distribution (CIRED 2023)}, + title={Power grid model: a high-performance distribution grid calculation library}, + year={2023}, + volume={2023}, + number={}, + pages={1089-1093}, + keywords={}, + doi={10.1049/icp.2023.0633} +} +``` + ## Contact 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. -