Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/citations readthedocs #451

Merged
merged 7 commits into from
Dec 15, 2023
Merged

Feature/citations readthedocs #451

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6bcd571
update readthedocs
mgovers Dec 15, 2023
983ff4c
update citation file
mgovers Dec 15, 2023
108ea4b
update readme with citations
mgovers Dec 15, 2023
07e8f17
fix contributing link
mgovers Dec 15, 2023
2e31728
minor
mgovers Dec 15, 2023
35b9d14
fix minor typo
mgovers Dec 15, 2023
c545af8
fix minor typo
mgovers Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@ build:
# Build package with doc requirements from pyproject.optional-dependencies
- pip install --verbose --editable .[doc]
# remove API DLL define in header
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/#define PGM.*//g" {} \;
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/PGM_API //g" {} \;
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/#define PGM.*//g" {} \;
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/PGM_API //g" {} \;
# build doxygen for C header
- cd docs/doxygen && doxygen && cd ../..
# download support
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/RELEASE.md
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SUPPORT.md
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SECURITY.md
petersalemink95 marked this conversation as resolved.
Show resolved Hide resolved
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/CITATION.md
# download contribution
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/GOVERNANCE.md
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CONTRIBUTING.md
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CODE_OF_CONDUCT.md
# fix links
- find docs/release_and_support -name *.md -exec sed -i -r "s|./CONTRIBUTING.md|../contribution/CONTRIBUTING.md|g" {} \;
23 changes: 22 additions & 1 deletion CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ authors:
affiliation: "Alliander"
- family-names: "Stoeller"
given-names: "Bram"
- family-names: "Wang"
given-names: "Zhen"
email: "Zhen.Wang@Alliander.com"
affiliation: "Alliander"
- family-names: "Guo"
given-names: "Jerry"
email: "Jerry.Jinfeng.Guo@Alliander.com"
affiliation: "Alliander"
- family-names: "Jagutis"
given-names: "Laurynas"
email: "Laurynas.Jagutis@Alliander.com"
Expand All @@ -41,7 +49,12 @@ authors:
given-names: "Chenguang"
email: "Chenguang.Wang@Alliander.com"
affiliation: "Alliander"
- name: "Contributors from the LF Energy project Power Grid Model"
- family-names: "Raalte"
name-particle: "van"
given-names: "Marc"
email: "Marc.van.Raalte@Alliander.com"
affiliation: "Alliander"
- name: "Contributors to the LF Energy project Power Grid Model"
contact:
- name: "LF Energy project Power Grid Model"
email: "powergridmodel+help@lists.lfenergy.org"
Expand Down Expand Up @@ -102,6 +115,14 @@ references:
affiliation: "Alliander"
- family-names: "Stoeller"
given-names: "Bram"
- family-names: "Wang"
given-names: "Zhen"
email: "Zhen.Wang@Alliander.com"
affiliation: "Alliander"
- family-names: "Guo"
given-names: "Jerry"
email: "Jerry.Jinfeng.Guo@Alliander.com"
affiliation: "Alliander"
- family-names: "Jagutis"
given-names: "Laurynas"
email: "Laurynas.Jagutis@Alliander.com"
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ If you are using Power Grid Model in your research work, please consider citing

```bibtex
@software{Xiang_PowerGridModel_power-grid-model,
author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Jagutis, Laurynas and Wang, Chenguang and {Contributors from the LF Energy project Power Grid Model}},
author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry 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}},
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,5 +111,6 @@ contribution/GOVERNANCE.md
:maxdepth: 2
release_and_support/RELEASE.md
release_and_support/SUPPORT.md
release_and_support/SECURITY.md
release_and_support/CITATION.md
```
Loading