From 44e06fa63209feb9df4b573b6efd1e6a77e69358 Mon Sep 17 00:00:00 2001
From: Mark Bonicillo <mark.bonicillo@pnnl.gov>
Date: Wed, 13 Mar 2024 09:23:22 -0700
Subject: [PATCH] HYP-396 Add CFF citation; add cff workflow and badge

---
 .github/workflows/cff.yml | 20 ++++++++++++
 CITATION.cff              | 68 +++++++++++++++++++++++++++++++++++++++
 README.md                 |  2 +-
 3 files changed, 89 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/cff.yml
 create mode 100644 CITATION.cff

diff --git a/.github/workflows/cff.yml b/.github/workflows/cff.yml
new file mode 100644
index 00000000..b493cf0b
--- /dev/null
+++ b/.github/workflows/cff.yml
@@ -0,0 +1,20 @@
+on:
+  push:
+    paths:
+      - CITATION.cff
+  workflow_dispatch:
+
+name: CITATION.cff
+jobs:
+  Validate-CITATION-cff:
+    runs-on: ubuntu-latest
+    name: Validate CITATION.cff
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Validate CITATION.cff
+        uses: dieghernan/cff-validator@v3
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 00000000..42f6bbf7
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,68 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Praggastis
+  given-names: Brenda
+  orcid: "https://orcid.org/0000-0003-1344-0497"
+- family-names: Aksoy
+  given-names: Sinan
+  orcid: "https://orcid.org/0000-0002-3466-3334"
+- family-names: Arendt
+  given-names: Dustin
+  orcid: "https://orcid.org/0000-0003-2466-199X"
+- family-names: Bonicillo
+  given-names: Mark
+  orcid: "https://orcid.org/0009-0003-9764-2180"
+- family-names: Joslyn
+  given-names: Cliff
+  orcid: "https://orcid.org/0000-0002-5923-5547"
+- family-names: Purvine
+  given-names: Emilie
+  orcid: "https://orcid.org/0000-0003-2069-5594"
+- family-names: Shapiro
+  given-names: Madelyn
+  orcid: "https://orcid.org/0000-0002-2786-7056"
+- family-names: Yun
+  given-names: Ji Young
+doi: 10.5281/zenodo.10795225
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Praggastis
+    given-names: Brenda
+    orcid: "https://orcid.org/0000-0003-1344-0497"
+  - family-names: Aksoy
+    given-names: Sinan
+    orcid: "https://orcid.org/0000-0002-3466-3334"
+  - family-names: Arendt
+    given-names: Dustin
+    orcid: "https://orcid.org/0000-0003-2466-199X"
+  - family-names: Bonicillo
+    given-names: Mark
+    orcid: "https://orcid.org/0009-0003-9764-2180"
+  - family-names: Joslyn
+    given-names: Cliff
+    orcid: "https://orcid.org/0000-0002-5923-5547"
+  - family-names: Purvine
+    given-names: Emilie
+    orcid: "https://orcid.org/0000-0003-2069-5594"
+  - family-names: Shapiro
+    given-names: Madelyn
+    orcid: "https://orcid.org/0000-0002-2786-7056"
+  - family-names: Yun
+    given-names: Ji Young
+  date-published: 2024-03-09
+  doi: 10.21105/joss.06016
+  issn: 2475-9066
+  issue: 95
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 6016
+  title: "HyperNetX: A Python package for modeling complex network data
+    as hypergraphs"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.06016"
+  volume: 9
+title: "HyperNetX: A Python package for modeling complex network data as
+  hypergraphs"
diff --git a/README.md b/README.md
index 344a942c..9fd7abc0 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ HyperNetX
 [![Pytest](https://github.com/pnnl/HyperNetX/actions/workflows/ci.yml/badge.svg)](https://github.com/pnnl/HyperNetX/actions/workflows/ci.yml)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)
-
+[![CITATION.cff](https://github.com/pnnl/HyperNetX/actions/workflows/cff.yml/badge.svg)](https://github.com/pnnl/HyperNetX/actions/workflows/cff.yml)
 
 The HyperNetX library provides classes and methods for the analysis
 and visualization of complex network data modeled as hypergraphs.