From f355f816c3d2452e6ffe8a6dd25154c5a2f9cc5d Mon Sep 17 00:00:00 2001 From: energyls Date: Tue, 2 May 2023 17:20:06 +0200 Subject: [PATCH 01/12] docs: add stackoverflow issue template --- .github/ISSUE_TEMPLATE/config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d8c04382..b357ab5f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,3 +3,6 @@ contact_links: - name: PyPSA Mailing List url: https://groups.google.com/forum/#!forum/pypsa about: Please ask and answer general usage questions here. +- name: Stackoverflow + url: https://stackoverflow.com/questions/tagged/pypsa + about: Please ask and answer code-related questions here. \ No newline at end of file From 4f890799455b11ccd671ebe0785e32d2c7d34d76 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 2 May 2023 15:21:48 +0000 Subject: [PATCH 02/12] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b357ab5f..03659213 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -5,4 +5,4 @@ contact_links: about: Please ask and answer general usage questions here. - name: Stackoverflow url: https://stackoverflow.com/questions/tagged/pypsa - about: Please ask and answer code-related questions here. \ No newline at end of file + about: Please ask and answer code-related questions here. From 2a1cdd1d7820ec242081cbab7a98789b2711772d Mon Sep 17 00:00:00 2001 From: energyls Date: Tue, 2 May 2023 17:39:01 +0200 Subject: [PATCH 03/12] docs: add shield and support section to readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2973fa33..02cc3163 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ SPDX-License-Identifier: CC-BY-4.0 [![Zenodo PyPSA-Eur-Sec](https://zenodo.org/badge/DOI/10.5281/zenodo.3938042.svg)](https://doi.org/10.5281/zenodo.3938042) [![Snakemake](https://img.shields.io/badge/snakemake-≥5.0.0-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io) [![REUSE status](https://api.reuse.software/badge/github.com/pypsa/pypsa-eur)](https://api.reuse.software/info/github.com/pypsa/pypsa-eur) +[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/pypsa)](https://stackoverflow.com/questions/tagged/pypsa) # PyPSA-Eur: A Sector-Coupled Open Optimisation Model of the European Energy System @@ -90,6 +91,14 @@ to 50-200 nodes. Already-built versions of the model can be found in the accompanying [Zenodo repository](https://doi.org/10.5281/zenodo.3601881). + +# Contributing and Support +We strongly welcome anyone interested in contributing to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on GitHub. +- In case of code-related **questions**, please post on [stack overflow](https://stackoverflow.com/questions/tagged/pypsa). +- For non-programming related and more general questions please refer to the [mailing list](https://groups.google.com/group/pypsa). +- To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). +- For **bugs and feature requests**, please use the [PyPSA-Eur Github Issues page](https://github.com/PyPSA/pypsa-eur/issues). + # Licence The code in PyPSA-Eur is released as free software under the From 42a9f40680b958c918f5436887a8c73cd2d7fdc6 Mon Sep 17 00:00:00 2001 From: energyls Date: Tue, 2 May 2023 17:49:26 +0200 Subject: [PATCH 04/12] docs: add shield to rst --- doc/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 521f080b..743444dd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -31,7 +31,9 @@ PyPSA-Eur: A Sector-Coupled Open Optimisation Model of the European Energy Syste :target: https://api.reuse.software/info/github.com/pypsa/pypsa-eur :alt: REUSE -| +|.. image:: https://img.shields.io/stackexchange/stackoverflow/t/pypsa + :target: https://stackoverflow.com/questions/tagged/pypsa + :alt: Stackoverflow PyPSA-Eur is an open model dataset of the European energy system at the transmission network level that covers the full ENTSO-E area. It covers demand From a6948ad39e44ecc4caaad8ccb8c3044ab1db7139 Mon Sep 17 00:00:00 2001 From: energyls Date: Wed, 3 May 2023 10:36:54 +0200 Subject: [PATCH 05/12] docs: add support.rst and add to TOC --- doc/index.rst | 1 + doc/support.rst | 10 ++++++++++ 2 files changed, 11 insertions(+) create mode 100644 doc/support.rst diff --git a/doc/index.rst b/doc/index.rst index 743444dd..2d53cfb0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -276,4 +276,5 @@ The included ``.nc`` files are PyPSA network files which can be imported with Py licenses limitations contributing + support publications diff --git a/doc/support.rst b/doc/support.rst new file mode 100644 index 00000000..1cd39e35 --- /dev/null +++ b/doc/support.rst @@ -0,0 +1,10 @@ + +------- +Support +------- + +* In case of code-related **questions**, please post on `stack overflow `_. +* For non-programming related and more general questions please refer to the `mailing list `_. +* To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). +* For **bugs and feature requests**, please use the `issue tracker `_. +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. \ No newline at end of file From 93d79da903c10ff51ebd1db494165ca99aa4c5ae Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 3 May 2023 08:37:21 +0000 Subject: [PATCH 06/12] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/support.rst b/doc/support.rst index 1cd39e35..f0a2c83c 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -7,4 +7,4 @@ Support * For non-programming related and more general questions please refer to the `mailing list `_. * To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). * For **bugs and feature requests**, please use the `issue tracker `_. -* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. \ No newline at end of file +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. From d5b1a05e379e1ce123383687983ed29a8db167d7 Mon Sep 17 00:00:00 2001 From: energyls Date: Wed, 3 May 2023 10:40:58 +0200 Subject: [PATCH 07/12] docs: add licence information to support.rst --- doc/support.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/support.rst b/doc/support.rst index f0a2c83c..36d1a2dd 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -1,7 +1,11 @@ +.. + SPDX-FileCopyrightText: 2019-2023 The PyPSA-Eur Authors -------- + SPDX-License-Identifier: CC-BY-4.0 + +####################### Support -------- +####################### * In case of code-related **questions**, please post on `stack overflow `_. * For non-programming related and more general questions please refer to the `mailing list `_. From e9787e77e4ce9bad1206de2495e5e5d2023fe7b7 Mon Sep 17 00:00:00 2001 From: energyls Date: Wed, 3 May 2023 10:53:47 +0200 Subject: [PATCH 08/12] docs: remove hyperref to check CI --- doc/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/support.rst b/doc/support.rst index 36d1a2dd..395c5f31 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -11,4 +11,4 @@ Support * For non-programming related and more general questions please refer to the `mailing list `_. * To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). * For **bugs and feature requests**, please use the `issue tracker `_. -* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to ... \ No newline at end of file From 817e82a80529dd34254643b9786a806eb2b6769c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 3 May 2023 08:54:47 +0000 Subject: [PATCH 09/12] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/support.rst b/doc/support.rst index 395c5f31..c0b4981b 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -11,4 +11,4 @@ Support * For non-programming related and more general questions please refer to the `mailing list `_. * To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). * For **bugs and feature requests**, please use the `issue tracker `_. -* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to ... \ No newline at end of file +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to ... From 673aab2925931ecc030a9d55b42c233774d45d86 Mon Sep 17 00:00:00 2001 From: energyls Date: Wed, 3 May 2023 10:58:46 +0200 Subject: [PATCH 10/12] fix: fix typo in index.rst --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 2d53cfb0..314900f7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -31,7 +31,7 @@ PyPSA-Eur: A Sector-Coupled Open Optimisation Model of the European Energy Syste :target: https://api.reuse.software/info/github.com/pypsa/pypsa-eur :alt: REUSE -|.. image:: https://img.shields.io/stackexchange/stackoverflow/t/pypsa +.. image:: https://img.shields.io/stackexchange/stackoverflow/t/pypsa :target: https://stackoverflow.com/questions/tagged/pypsa :alt: Stackoverflow From da022db624b3d4fb1290ee4121ffee04c1a2a6dc Mon Sep 17 00:00:00 2001 From: energyls Date: Wed, 3 May 2023 11:03:54 +0200 Subject: [PATCH 11/12] docs: add reference to contributing --- doc/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/support.rst b/doc/support.rst index c0b4981b..f57e2289 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -11,4 +11,4 @@ Support * For non-programming related and more general questions please refer to the `mailing list `_. * To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). * For **bugs and feature requests**, please use the `issue tracker `_. -* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to ... +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. \ No newline at end of file From f0453c42c0266468bc3cc0dfe1bf527f778dff2d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 3 May 2023 09:05:26 +0000 Subject: [PATCH 12/12] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/support.rst b/doc/support.rst index f57e2289..36d1a2dd 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -11,4 +11,4 @@ Support * For non-programming related and more general questions please refer to the `mailing list `_. * To **discuss** with other PyPSA users, organise projects, share news, and get in touch with the community you can use the [discord server](https://discord.gg/JTdvaEBb). * For **bugs and feature requests**, please use the `issue tracker `_. -* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`. \ No newline at end of file +* We strongly welcome anyone interested in providing **contributions** to this project. If you have any ideas, suggestions or encounter problems, feel invited to file issues or make pull requests on `Github `_. For further information on how to contribute, please refer to :ref:`contributing`.