Merge pull request #40 from ARTIST-Association/maintenance/fair4rs

Maintenance/fair4rs

.github/workflows/fair-software.yml

@@ -0,0 +1,17 @@
+name: fair-software
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  verify:
+    name: "fair-software"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fair-software/howfairis-github-action@0.2.1
+        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 }}"

.github/workflows/python-test.yml

@@ -27,51 +27,25 @@ jobs:
         uses: actions/setup-python@main
         with:
           python-version: ${{ matrix.python-version }}
-      # You can test your matrix by printing the current Python version
-
-      - name: Display Python version
-        run: python -c "import sys; print(sys.version)"
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install pytest pytest-cov coverage-badge .
 
       - name: Test with pytest and coverage badge
-        if: matrix.python-version != '3.12'
         run: |
           pytest --cov=paint
-          coverage-badge -fo coverage.svg
           coverage report -m --format markdown > cov_report.txt
+          coverage xml
 
       - name: Post coverage report to PR
         if: matrix.python-version == '3.11'
         uses: marocchino/sticky-pull-request-comment@v2
         with:
           path: cov_report.txt
 
-      - name: Tests with pytest and no badge
-        if: matrix.python-version == '3.12'
-        run: |
-          pytest --cov=paint
-
-      - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v19
-        id: verify-changed-files
-        with:
-          files: coverage.svg
-
-      - name: Commit files
-        if: steps.verify-changed-files.outputs.files_changed == 'true' && matrix.python-version == '3.11'
-        run: |
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-          git add coverage.svg
-          git commit -m "Updated coverage.svg"
-
-      - name: Push changes
-        if: steps.verify-changed-files.outputs.files_changed == 'true' && matrix.python-version == '3.11'
-        uses: ad-m/github-push-action@master
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
         with:
-          github_token: ${{ secrets.github_token }}
-          branch: ${{ github.head_ref }}
+          token: ${{ secrets.CODECOV_TOKEN }}

CITATION.cff

@@ -11,58 +11,71 @@ authors:
   - given-names: Max
     family-names: Pargmann
     email: max.pargmann@dlr.de
-    affiliation: German Aerospace Center
+    affiliation: German Aerospace Center (DLR)
     orcid: 'https://orcid.org/0000-0002-4705-6285'
   - given-names: Kaleb
     family-names: Phipps
     email: kaleb.phipps@kit.edu
-    affiliation: Karlruhe Institute of Technology
+    affiliation: Karlsruhe Institute of Technology (KIT)
     orcid: 'https://orcid.org/0000-0002-9197-1739'
   - given-names: Marie
     family-names: Weiel
     email: marie.weiel@kit.edu
-    affiliation: Karlruhe Institute of Technology
+    affiliation: Karlsruhe Institute of Technology (KIT)
     orcid: 'https://orcid.org/0000-0001-9648-4385'
   - given-names: Mathias
     family-names: Kuhl
     email: mathias.kuhl@dlr.de
-    affiliation: German Aerospace Center
+    affiliation: German Aerospace Center (DLR)
     orcid: 'https://orcid.org/0000-0003-0097-7260'
   - given-names: Marlene
     family-names: Busch
     email: marlene.busch@dlr.de
-    affiliation: German Aerospace Center
-  - given-names: Fehlix
+    affiliation: German Aerospace Center (DLR)
+  - given-names: Felix
     family-names: Göhring
-    email: Felix.Goehring@dlr.de
-    affiliation: German Aerospace Center
-  - given-names: 'Daniel '
+    email: felix.goehring@dlr.de
+    affiliation: German Aerospace Center (DLR)
+  - given-names: Daniel
     family-names: Maldonado Quinto
-    email: Daniel.MaldonadoQuinto@dlr.de
-    affiliation: German Aerospace Center
+    email: daniel.maldonadoquinto@dlr.de
+    affiliation: German Aerospace Center (DLR)
   - given-names: Robert
     family-names: Pitz-Paal
     orcid: 'https://orcid.org/0000-0002-3542-3391'
-    email: Robert.Pitz-Paal@dlr.de
-    affiliation: German Aerospace Center
+    email: rRobert.pitz-paal@dlr.de
+    affiliation: German Aerospace Center (DLR)
   - given-names: Moritz
     family-names: Leibauer
-    email: Moritz.Leibauer@synhelion.com
+    email: moritz.leibauer@synhelion.com
     affiliation: Synhelion Germany
   - given-names: Markus
     family-names: Götz
     email: markus.goetz@kit.edu
-    affiliation: Karlruhe Institute of Technology
+    affiliation: Karlsruhe Institute of Technology (KIT)
     orcid: 'https://orcid.org/0000-0002-2233-1041'
 repository-code: 'https://github.com/ARTIST-Association/PAINT'
 url: 'https://www.paint-database.org'
-repository: 'https://github.com/ARTIST-Association'
+abstract: >-
+  The PAINT database makes operational data of concentrating
+  solar power plants available in accordance with the FAIR
+  data principles, i.e., making them findable, accessible,
+  interoperable, and reusable. Currently, the data
+  encompasses calibration images, deflectometry
+  measurements, kinematic settings, and weather information
+  of the concentrating solar power plant in Jülich, Germany,
+  with the global power plant id (GPPD) WRI1030197. Metadata
+  for all database entries follow the spatio-temporal asset
+  catalog (STAC) standard. PAINT closely follows open
+  science guidelines and makes all software to (pre-)process
+  data publicly available in the project's source code
+  repository.
 keywords:
-  - Solar Tower
+  - Solar Tower Power Plant
   - Concentrated Solar Energy
   - Database
   - Heliostat Calibration
   - Deflectometry
   - Surface Reconstruction
   - Benchmark
-license: MIT
+license: CDLA 2.0

README.md

@@ -5,8 +5,11 @@
 # PAINT
 
 [![](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://www.python.org/downloads/)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)[![](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://www.python.org/downloads/)[![](https://img.shields.io/badge/Contact-artist%40lists.kit.edu-orange?label=Contact)](artist@lists.kit.edu)
-![](./coverage.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![](https://img.shields.io/badge/Contact-artist%40lists.kit.edu-blue?label=Contact)](artist@lists.kit.edu)
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B%20%20%E2%97%8F%20%20%E2%97%8B-orange)](https://fair-software.eu)
+[![codecov](https://codecov.io/gh/ARTIST-Association/PAINT/graph/badge.svg?token=B2pjCVgOhc)](https://codecov.io/gh/ARTIST-Association/PAINT)
 
 ## What is ``PAINT``