Merge pull request #23 from mcflugen/mcfluen/add-citation-file

Add a citation file
mcflugen · Apr 29, 2024 · 4214afd · 4214afd
2 parents 9c47d33 + c02b863
commit 4214afd
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,28 @@
+# YAML 1.2
+cff-version: 1.2.0
+title: compaction
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+abstract: >-
+  Compact columns of layered sediment following the numerical
+  solution described in Bahr et al., 2001.
+type: software
+authors:
+  - given-names: Eric
+    family-names: Hutton
+    email: [email protected]
+    affiliation: University of Colorado
+    orcid: 'https://orcid.org/0000-0002-5864-6459'
+repository-code: "https://github.com/mcflugen/compaction"
+url: "https://github.com/mcflugen/compaction/blob/master/README.md"
+date-released: "2022-06-26"
+keywords:
+  - "bmi"
+  - "component modeling"
+  - "earth science"
+  - "landlab"
+  - "model coupling"
+  - "numerical modeling"
+  - "sediment compaction"
+license: MIT
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,6 @@
 include .coveragerc
 include .pre-commit-config.yaml
+include CITATION.cff
 include LICENSE.md
 include NEWS.md
 include asv.conf.json

diff --git a/news/23.misc b/news/23.misc
@@ -0,0 +1,2 @@
+
+Added a citation file.