add CITATION.cff file for assisting citing

m2lines · Nov 9, 2023 · b50b3b6 · b50b3b6
1 parent 1d1e934
commit b50b3b6
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,18 @@
+# vim: ft=yaml
+
+cff-version: 1.2.0
+title: GZ21 Ocean Momentum
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+- given-names: Arthur P.
+  family-names: Guillaumin
+  orcid: 'https://orcid.org/0000-0003-1571-4228'
+  affiliation: >-
+    Courant Institute of Mathematical Sciences, New York
+    University, New York, NY, USA
+  email: [email protected]
+version: 0.2.0
+date-released: 2023-11-09
diff --git a/README.md b/README.md
@@ -260,3 +260,7 @@ projects until we have reached a code release milestone.
 ## License
 This repository is provided under the MIT license. See [`LICENSE`](LICENSE) for
 license text and copyright information.
+
+## Citing this software
+See `CITATION.cff` for citation metadata for this software. *(For further
+details on usage, see https://citation-file-format.github.io/ .)*