From 962da63023ca67d2dc22bd08acf0cd37772765e7 Mon Sep 17 00:00:00 2001 From: "E. G. Patrick Bos" Date: Thu, 27 Jan 2022 17:20:41 +0100 Subject: [PATCH 1/4] add howfairis badge Also slightly reorder badges. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2febf1f1..38c03d11 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,14 @@ affiliations: --> [![build](https://github.com/dianna-ai/dianna/actions/workflows/build.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/build.yml) -[![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=coverage)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) [![workflow pypi badge](https://img.shields.io/pypi/v/dianna.svg?colorB=blue)](https://pypi.python.org/project/dianna/) [![supported python versions](https://img.shields.io/pypi/pyversions/dianna)](https://pypi.python.org/project/dianna/) - - [![Documentation Status](https://readthedocs.org/projects/dianna/badge/?version=latest)](https://dianna.readthedocs.io/en/latest/?badge=latest) + +[![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=coverage)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5542/badge)](https://bestpractices.coreinfrastructure.org/projects/5542) +[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) + [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5592607.svg)](https://zenodo.org/record/5592607) [![more badges badge](https://img.shields.io/badge/more-badges-lightgrey)](badges.md) From 052719ab83b79805200015a587d023140fd9f671 Mon Sep 17 00:00:00 2001 From: "E. G. Patrick Bos" Date: Thu, 27 Jan 2022 17:27:08 +0100 Subject: [PATCH 2/4] reorder README badges and remove unused ones --- README.md | 16 ++++++++++------ badges.md | 14 -------------- 2 files changed, 10 insertions(+), 20 deletions(-) delete mode 100644 badges.md diff --git a/README.md b/README.md index 38c03d11..8dab23b1 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,12 @@ affiliations: --> [![build](https://github.com/dianna-ai/dianna/actions/workflows/build.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/build.yml) -[![workflow pypi badge](https://img.shields.io/pypi/v/dianna.svg?colorB=blue)](https://pypi.python.org/project/dianna/) -[![supported python versions](https://img.shields.io/pypi/pyversions/dianna)](https://pypi.python.org/project/dianna/) [![Documentation Status](https://readthedocs.org/projects/dianna/badge/?version=latest)](https://dianna.readthedocs.io/en/latest/?badge=latest) [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=coverage)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5542/badge)](https://bestpractices.coreinfrastructure.org/projects/5542) [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5592607.svg)](https://zenodo.org/record/5592607) -[![more badges badge](https://img.shields.io/badge/more-badges-lightgrey)](badges.md) - # DIANNA: Deep Insight And Neural Network Analysis @@ -58,6 +53,13 @@ Solutions: 4. A web demonstrator will be created in a next phase of the project. ## Installation +[![workflow pypi badge](https://img.shields.io/pypi/v/dianna.svg?colorB=blue)](https://pypi.python.org/project/dianna/) +[![supported python versions](https://img.shields.io/pypi/pyversions/dianna)](https://pypi.python.org/project/dianna/) + +The easiest way to install DIANNA is using `pip` on one of the supported Python versions: +```console +pip install dianna +``` To install DIANNA directly from the GitHub repository, do: @@ -125,7 +127,7 @@ LRP and PatternAttribution also feature in the top 5 of our thoroughly evaluated ## Reference documentation -For detailed information on using specific DIANNA functions, please visit the [Sphinx documentation page hosted at Readthedocs](https://dianna.readthedocs.io/en/latest). +For detailed information on using specific DIANNA functions, please visit the [documentation page hosted at Readthedocs](https://dianna.readthedocs.io/en/latest). ## Contributing @@ -133,6 +135,8 @@ If you want to contribute to the development of DIANNA, have a look at the [contribution guidelines](https://github.com/dianna-ai/dianna/blob/main/CONTRIBUTING.md). ## How to cite us +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5592607.svg)](https://zenodo.org/record/5592607) +[![RSD](https://img.shields.io/badge/rsd-dianna-00a3e3.svg)](https://www.research-software.nl/software/dianna) If you use this package for your scientific work, please consider citing it as: diff --git a/badges.md b/badges.md deleted file mode 100644 index 3c1c64fd..00000000 --- a/badges.md +++ /dev/null @@ -1,14 +0,0 @@ -| fair-software.eu recommendations | | -| :-- | :-- | -| license | [![github license badge](https://img.shields.io/github/license/dianna-ai/dianna)](https://github.com/dianna-ai/dianna) | -| community registry | [![RSD](https://img.shields.io/badge/rsd-dianna-00a3e3.svg)](https://www.research-software.nl/software/dianna) [![workflow pypi badge](https://img.shields.io/pypi/v/dianna.svg?colorB=blue)](https://pypi.python.org/project/dianna/) | -| citation | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5592606.svg)](https://doi.org/10.5281/zenodo.5592606) | -| howfairis | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) | -| **Other best practices** |   | -| Static analysis | [![workflow scq badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=alert_status)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) | -| Coverage | [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=coverage)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) | -| **GitHub Actions** |   | -| Build | [![build](https://github.com/dianna-ai/dianna/actions/workflows/build.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/build.yml) | -| Citation data consistency | [![cffconvert](https://github.com/dianna-ai/dianna/actions/workflows/cffconvert.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/cffconvert.yml) | -| SonarCloud | [![sonarcloud](https://github.com/dianna-ai/dianna/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/sonarcloud.yml) | -| MarkDown link checker | [![markdown-link-check](https://github.com/dianna-ai/dianna/actions/workflows/markdown-link-check.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/markdown-link-check.yml) | From c6a7ec56cad716a5de8ed9a1b543fb11a32fc4c9 Mon Sep 17 00:00:00 2001 From: "E. G. Patrick Bos" Date: Thu, 27 Jan 2022 17:32:24 +0100 Subject: [PATCH 3/4] [CI] add fair software github action --- .github/workflows/fair-software.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/fair-software.yml diff --git a/.github/workflows/fair-software.yml b/.github/workflows/fair-software.yml new file mode 100644 index 00000000..ed7668ec --- /dev/null +++ b/.github/workflows/fair-software.yml @@ -0,0 +1,15 @@ +name: fair-software + +on: push + +jobs: + verify: + name: "fair-software" + runs-on: ubuntu-latest + steps: + - uses: fair-software/howfairis-github-action@0.2.0 + name: Measure compliance with fair-software.eu recommendations + env: + PYCHARM_HOSTED: "Trick colorama into displaying colored output" + with: + MY_REPO_URL: "https://github.com/${{ github.repository }}" \ No newline at end of file From 857e56c0a016448bd458b3fa6c69f7ca383dc2b6 Mon Sep 17 00:00:00 2001 From: "E. G. Patrick Bos" Date: Mon, 31 Jan 2022 15:13:49 +0100 Subject: [PATCH 4/4] review comments: one-line o' badges, howfairis PR branch --- .github/workflows/fair-software.yml | 25 ++++++++++++++++++++++--- README.md | 1 - 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/.github/workflows/fair-software.yml b/.github/workflows/fair-software.yml index ed7668ec..a6d8989f 100644 --- a/.github/workflows/fair-software.yml +++ b/.github/workflows/fair-software.yml @@ -1,15 +1,34 @@ name: fair-software -on: push +on: + workflow_dispatch: + push: + branches: + - main + pull_request: + branches: + - main jobs: - verify: + verify_main: name: "fair-software" runs-on: ubuntu-latest + if: ${{ github.event_name != 'pull_request' }} steps: - uses: fair-software/howfairis-github-action@0.2.0 name: Measure compliance with fair-software.eu recommendations env: PYCHARM_HOSTED: "Trick colorama into displaying colored output" with: - MY_REPO_URL: "https://github.com/${{ github.repository }}" \ No newline at end of file + MY_REPO_URL: "https://github.com/${{ github.repository }}" + verify_pull_request: + name: "fair-software" + runs-on: ubuntu-latest + if: ${{ github.event_name == 'pull_request' }} + steps: + - uses: fair-software/howfairis-github-action@0.2.0 + name: Measure compliance with fair-software.eu recommendations + env: + PYCHARM_HOSTED: "Trick colorama into displaying colored output" + with: + MY_REPO_URL: "https://github.com/${{ github.repository }}/refs/remotes/pull/${{ github.event.pull_request.number }}/merge" \ No newline at end of file diff --git a/README.md b/README.md index 8dab23b1..a52c17f7 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,6 @@ affiliations: [![build](https://github.com/dianna-ai/dianna/actions/workflows/build.yml/badge.svg)](https://github.com/dianna-ai/dianna/actions/workflows/build.yml) [![Documentation Status](https://readthedocs.org/projects/dianna/badge/?version=latest)](https://dianna.readthedocs.io/en/latest/?badge=latest) - [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=dianna-ai_dianna&metric=coverage)](https://sonarcloud.io/dashboard?id=dianna-ai_dianna) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5542/badge)](https://bestpractices.coreinfrastructure.org/projects/5542) [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)