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 # already done by requirements-cron.yml
   skip:
+    - check-jsonschema
     - mypy
     - pyright
     - taplo
@@ -80,6 +81,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

@@ -69,6 +69,7 @@
     "tests/**/__init__.py": 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,36 @@
+cff-version: 1.2.0
+message: If you use this software, please cite it as below.
+title: >-
+  ComPWA/tensorwaves: Python fitter package for multiple computational back-ends
+abstract: |-
+  TensorWaves is a fitter package that optimizes mathematical models to data samples. The models can be any  _symbolic_  mathematical expression that is then converted to any computational backend. In addition, TensorWaves provides functionality to generate toy Monte Carlo data samples. The package is developed in parallel with [AmpForm](https://github.com/ComPWA/ampform), which implements physics models, but its 'lambdifying' mechanisms can in principle be used independently.
+
+authors:
+  - family-names: Fritsch
+    given-names: Miriam
+    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
+  - family-names: Gradl
+    given-names: Wolfgang
+    affiliation: Johannes Gutenberg University Mainz
+  - family-names: Peters
+    given-names: Klaus
+    affiliation: GSI Helmholtzzentrum für Schwerionenforschung
+doi: 10.5281/zenodo.5526650
+keywords:
+  - partial wave analysis
+  - amplitude analysis
+  - computer algebra system
+  - optimizer
+  - minimizer
+  - tensorflow
+  - jax
+  - numpy
+license: GPL-3.0-or-later
+repository-code: https://github.com/ComPWA/tensorwaves
+url: https://tensorwaves.readthedocs.io