Add citation information (#240)

* Add zenodo badge and citation to readme

* Create CITATION.CFF

* Use full names

* Add citation file to manifest

* Add citation to website

* updated citation.cff file after validation by cffinit

* remove 2nd date from citation entry

* homepage citation is included from README

* added Sofia to pyproject.toml authors

* harmonise spelling of my own name

---------

Co-authored-by: niksirbi <[email protected]>

CITATION.CFF

@@ -0,0 +1,43 @@
+cff-version: 1.2.0
+title: movement
+message: >-
+  If you use movement in your work, please cite the following Zenodo DOI.
+type: software
+authors:
+  - given-names: Nikoloz
+    family-names: Sirmpilatze
+    orcid: 'https://orcid.org/0000-0003-1778-2427'
+    email: [email protected]
+  - given-names: Chang Huan
+    family-names: Lo
+  - given-names: Sofía
+    family-names: Miñano
+  - given-names: Brandon D.
+    family-names: Peri
+  - given-names: Dhruv
+    family-names: Sharma
+  - given-names: Laura
+    family-names: Porta
+  - given-names: Iván
+    family-names: Varela
+  - given-names: Adam L.
+    family-names: Tyson
+    email: [email protected]
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.12755724
+    description: 'A collection of archived snapshots of movement on Zenodo.'
+repository-code: 'https://github.com/neuroinformatics-unit/movement'
+url: 'https://movement.neuroinformatics.dev/'
+abstract: >-
+  Python tools for analysing body movements across space and time.
+keywords:
+  - behavior
+  - behaviour
+  - kinematics
+  - neuroscience
+  - animal
+  - motion
+  - tracking
+  - pose
+license: BSD-3-Clause

MANIFEST.in

@@ -1,5 +1,6 @@
 include LICENSE
 include *.md
+include CITATION.CFF
 exclude .pre-commit-config.yaml
 exclude .cruft.json
 

README.md

@@ -5,6 +5,7 @@
 [![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement/topic/Welcome!)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12755724.svg)](https://zenodo.org/doi/10.5281/zenodo.12755724)
 
 # movement
 
@@ -49,6 +50,12 @@ To help you get started, we have prepared a detailed [contributing guide](https:
 
 You are welcome to chat with the team on [zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement). You can also [open an issue](https://github.com/neuroinformatics-unit/movement/issues) to report a bug or request a new feature.
 
+## Citation
+
+If you use `movement` in your work, please cite the following Zenodo DOI:
+
+> Nikoloz Sirmpilatze, Chang Huan Lo, Sofía Miñano, Brandon D. Peri, Dhruv Sharma, Laura Porta, Iván Varela & Adam L. Tyson (2024). neuroinformatics-unit/movement. Zenodo. https://zenodo.org/doi/10.5281/zenodo.12755724
+
 ## License
 ⚖️ [BSD 3-Clause](./LICENSE)
 

docs/source/index.md

@@ -42,6 +42,12 @@ Find out more on our [mission and scope](target-mission) statement and our [road
 ```{include} /snippets/status-warning.md
 ```
 
+## Citation
+```{include} ../../README.md
+:start-after: '## Citation'
+:end-before: '## License'
+```
+
 ```{toctree}
 :maxdepth: 2
 :hidden:

pyproject.toml

@@ -1,8 +1,9 @@
 [project]
 name = "movement"
 authors = [
-  { name = "Niko Sirmpilatze", email = "[email protected]" },
+  { name = "Nikoloz Sirmpilatze", email = "[email protected]" },
   { name = "Chang Huan Lo", email = "[email protected]" },
+  { name = "Sofía Miñano", email = "[email protected]" },
 ]
 description = "Analysis of body movement"
 readme = "README.md"