DOC: add CITATION.cff

.pre-commit-config.yaml

@@ -2,6 +2,7 @@ ci:
   autoupdate_commit_msg: "MAINT: update pip constraints and pre-commit"
   autoupdate_schedule: quarterly
   skip:
+    - check-jsonschema
     - pyright
     - taplo
 
@@ -72,6 +73,19 @@ repos:
     hooks:
       - id: blacken-docs
 
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.24.1
+    hooks:
+      - id: check-jsonschema
+        name: Check CITATION.cff
+        args:
+          - --default-filetype
+          - yaml
+          - --schemafile
+          - https://citation-file-format.github.io/1.2.0/schema.json
+          - CITATION.cff
+        pass_filenames: false
+
   - repo: https://github.com/streetsidesoftware/cspell-cli
     rev: v7.0.1
     hooks:

.vscode/settings.json

@@ -21,7 +21,9 @@
   "black-formatter.importStrategy": "fromEnvironment",
   "cSpell.enabled": true,
   "editor.formatOnSave": true,
-  "editor.rulers": [88],
+  "editor.rulers": [
+    88
+  ],
   "editor.unicodeHighlight.allowedCharacters": {
     "\u03bd": true,
     "\u03c3": true
@@ -33,10 +35,14 @@
     "**/.tox/**": true
   },
   "git.rebaseWhenSync": true,
-  "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],
+  "github-actions.workflows.pinned.workflows": [
+    ".github/workflows/ci.yml"
+  ],
   "json.schemas": [
     {
-      "fileMatch": [".zenodo.json"],
+      "fileMatch": [
+        ".zenodo.json"
+      ],
       "url": "https://zenodo.org/schemas/deposits/records/legacyrecord.json"
     }
   ],
@@ -52,6 +58,7 @@
     ".constraints/*.txt": true
   },
   "yaml.schemas": {
+    "https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff",
     "https://json.schemastore.org/github-workflow.json": "./.github/workflows/requirements.yml"
   }
 }

CITATION.cff

@@ -0,0 +1,52 @@
+cff-version: 1.2.0
+message: If you use this software, please cite it as below.
+title: >-
+  Common Partial Wave Analysis: A collaboration-independent organisation for amplitude analysis
+  software
+abstract: |-
+  The ["Common Partial Wave Analysis"](https://github.com/ComPWA) organization (ComPWA) aims to make amplitude analysis accessible through transparent and interactive documentation, modern software development tools, and collaboration-independent frameworks.
+
+authors:
+  - family-names: Fritsch
+    given-names: Miriam
+    affiliation: Ruhr University Bochum
+    orcid: https://orcid.org/0000-0002-6463-8295
+  - family-names: Michel
+    given-names: Mathias
+    affiliation: Ruhr University Bochum
+  - family-names: Pflüger
+    given-names: Stefan
+    affiliation: Ruhr University Bochum
+  - family-names: de Boer
+    given-names: Remco E.
+    affiliation: Ruhr University Bochum
+    orcid: https://orcid.org/0000-0001-5846-2206
+  - family-names: Wollenberg
+    given-names: Leonard
+    affiliation: Ruhr University Bochum
+  - family-names: Gradl
+    given-names: Wolfgang
+    affiliation: Johannes Gutenberg University Mainz
+    orcid: https://orcid.org/0000-0002-9974-8320
+  - family-names: Weidenkaff
+    given-names: Peter
+    affiliation: Johannes Gutenberg University Mainz
+    orcid: https://orcid.org/0000-0002-5529-438X
+  - family-names: Peters
+    given-names: Klaus
+    affiliation: GSI Helmholtzzentrum für Schwerionenforschung
+    orcid: https://orcid.org/0000-0001-7133-0662
+  - family-names: Götzen
+    given-names: Klaus
+    affiliation: GSI Helmholtzzentrum für Schwerionenforschung
+    orcid: https://orcid.org/0000-0002-0782-3806
+doi: 10.5281/zenodo.6908149
+keywords:
+  - particle physics
+  - amplitude analysis
+  - partial wave analysis
+  - computer algebra system
+license: GPL-3.0-or-later
+repository-code: https://github.com/ComPWA/compwa-org
+type: software
+url: https://compwa-org.readthedocs.io