Merge pull request #1361 from nickerso/citing-libcellml

Updating citation information for libCellML

Author: hsorby

CITATION.cff

@@ -0,0 +1,31 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: libCellML
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name: libCellML Contributors
+    website: >-
+      https://github.com/cellml/libcellml/graphs/contributors
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.6975548
+    description: The concept DOI of the work.
+repository-code: 'https://github.com/cellml/libcellml'
+url: 'https://libcellml.org'
+abstract: >-
+  The purpose of libCellML is to provide a software library
+  for tool developers to support CellML in their
+  applications. CellML is a specification to store and
+  exchange computer-based mathematical models, allowing
+  scientists to share models even if they are using
+  different model-building software.
+keywords:
+  - CellML
+  - Physiome Project
+  - COMBINE
+license: Apache-2.0

README.rst

@@ -1,3 +1,7 @@
+.. image:: https://img.shields.io/badge/DOI-10.5281%2Fzenodo.6975548-blue.svg
+  :target: https://doi.org/10.5281/zenodo.6975548
+  :alt: DOI
+
 .. image:: https://github.com/cellml/libcellml/actions/workflows/deploy-on-release.yml/badge.svg
   :width: 200
   :target: https://github.com/cellml/libcellml/actions/workflows/deploy-on-release.yml
@@ -36,3 +40,16 @@ libCellML is an open-source project, thus, welcoming contributions.
 
 If you are interested we encourage you to fork `libCellML on GitHub <https://github.com/cellml/libcellml>`_ and submit a pull request with your modifications.
 For more information on contributing code see the documentation at https://libcellml.org/.
+
+How to cite
+-----------
+
+We put a lot of effort into developing this tool. If it helps your research, please consider citing the latest version:
+
+.. image:: https://img.shields.io/badge/DOI-10.5281%2Fzenodo.6975548-blue.svg
+  :target: https://doi.org/10.5281/zenodo.6975548
+  :alt: DOI
+
+You can use the "Cite this repository" button in the sidebar to export the citation in your preferred format (BibTeX, APA, etc.).
+
+For specific versioning requirements (e.g., for reproducibility), you can find DOIs for individual releases on `our Zenodo page <https://doi.org/10.5281/zenodo.6975548>`_.