Merge pull request #234 from nasa/feature/issue-229-add-joss-info

Feature/issue 229 add joss info

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [unreleased]
+### Added
+- [Issue #229](https://github.com/nasa/ncompare/issues/229): Added Journal of Open Source Software (JOSS) info to README and CITATION docs.
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
 ## [1.9.0]
 ### Added
 - [Issue #210](https://github.com/nasa/ncompare/issues/210): Add gif of usage to readme

CITATION.cff

@@ -1,11 +1,35 @@
-cff-version: 1.2.0
-
-message: |
-  Please cite this software using these metadata.
-  Authors are listed in alphabetical order.
-
-title: "ncompare"
-abstract: "Compare the structure of two NetCDF files at the command line."
+cff-version: "1.2.0"
+authors:
+- family-names: Kaufman
+  given-names: Daniel E.
+  orcid: "https://orcid.org/0000-0002-1487-7298"
+- family-names: Baskin
+  given-names: Walter E.
+  orcid: "https://orcid.org/0000-0002-2241-3266"
+doi: 10.5281/zenodo.11448464
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Kaufman
+    given-names: Daniel E.
+    orcid: "https://orcid.org/0000-0002-1487-7298"
+  - family-names: Baskin
+    given-names: Walter E.
+    orcid: "https://orcid.org/0000-0002-2241-3266"
+  date-published: 2024-06-06
+  doi: 10.21105/joss.06490
+  issn: 2475-9066
+  issue: 98
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 6490
+  title: "ncompare: A Python package for comparing netCDF structures"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.06490"
+  volume: 9
+title: "ncompare: A Python package for comparing netCDF structures"
 
 contact:
   - name: "The NASA ncompare issues page"
@@ -14,18 +38,5 @@ keywords:
   - "netcdf"
   - "data comparison"
   - "hierarchical data"
-
 url: "https://ncompare.readthedocs.io"
 repository-code: "https://github.com/nasa/ncompare"
-
-version: 1.9.0
-date-released: 2024-05-29
-
-authors:
-- family-names: "Baskin"
-  given-names: "Walter"
-  orcid: "https://orcid.org/0000-0002-2241-3266"
-- family-names: "Kaufman"
-  given-names: "Daniel E"
-  orcid: "https://orcid.org/0000-0002-1487-7298"
-  website: "https://github.com/danielfromearth"

README.md

@@ -31,6 +31,9 @@ _____
 <a href="https://github.com/pyOpenSci/software-review/issues/146" target="_blank">
     <img src="https://tinyurl.com/y22nb8up?" alt="pyOpenSci">
 </a>
+<a style="border-width:0" href="https://doi.org/10.21105/joss.06490">
+  <img src="https://joss.theoj.org/papers/10.21105/joss.06490/status.svg" alt="DOI badge" >
+</a>
 
 Compare the structure of two NetCDF files at the command line.
 `ncompare` generates a view of the matching and non-matching groups and variables between two NetCDF datasets.