Adapt citation and add cff test (#206)

* Add CITATION.cff workflow
* Add abstract to CITATION.cff
* adjust editors in CITATION.cff
* Add contact person in CITATION.cff
* Minor fix with wrongly named variable in demo workflow: rename matrix.python-inplace to matrix.inplace

.github/workflows/citation.yml

@@ -0,0 +1,36 @@
+name: Validate CITATION.cff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  build:
+    name: Validate CITATION.cff
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Skip Duplicate Actions
+      uses: fkirc/skip-duplicate-actions@v5
+
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.8
+
+    - name: Install cffconvert
+      run: |
+        pip3 install --user cffconvert
+        cffconvert --version
+
+    - name: Validate schema
+      run: |
+        cffconvert --validate -i CITATION.cff

.github/workflows/demo.yaml

@@ -36,7 +36,7 @@ jobs:
 
     - name: Install Python dependencies
       run: |
-        pip3 install --user ${{ matrix.python-inplace }} .
+        pip3 install --user ${{ matrix.inplace }} .
 
     - name: Run demo
       run: |

CITATION.cff

@@ -3,6 +3,12 @@
 
 cff-version: 1.2.0
 title: ConFlowGen
+abstract: A generator for synthetic container flows at maritime container terminals with a focus on yard operations
+contact:
+  - affiliation: "Institute of Maritime Logistics, Hamburg University of Technology (TUHH)"
+    email: [email protected]
+    family-names: Kastner
+    given-names: Marvin
 message: >-
   Please cite this software using the metadata from
   'preferred-citation'.
@@ -47,7 +53,7 @@ preferred-citation:
       country: DE
       date-start: 2022-02-23
       date-end: 2022-02-25
-  editors-series:
+  editors:
     - family-names: Freitag
       given-names: Michael
     - family-names: Kinra

Readme.md

@@ -1,5 +1,6 @@
 [![Documentation Status](https://readthedocs.org/projects/conflowgen/badge/?version=latest)](https://conflowgen.readthedocs.io/en/latest/?badge=latest)
-[![Docs](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml)
+[![documentation built](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml)
+[![CITATION.cff valid](https://github.com/1kastner/conflowgen/actions/workflows/citation.yml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/citation.yml)
 
 [![Tests](https://github.com/1kastner/conflowgen/actions/workflows/unittests.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/unittests.yaml)
 [![codecov](https://codecov.io/gh/1kastner/conflowgen/branch/main/graph/badge.svg?token=GICVMYHJ42)](https://codecov.io/gh/1kastner/conflowgen)