Merge pull request #91 from computational-psychology/dev_citation

docs: added citation to readme and docs

README.md

@@ -79,7 +79,7 @@ so that they are reproducible, flexible, and easy.
 
 - modular and therefore easy to extend with new stimulus functions,
   and new stimulus sets
- 
+
 - [utility functions](https://stimupy.readthedocs.io/en/latest/reference/_api/stimupy.utils.html)
   for stimulus import, export, manipulation (e.g. contrast, size), or plotting
 
@@ -97,6 +97,32 @@ See the [documentation](https://stimupy.readthedocs.io/en/latest/) for more deta
 
 ## Citing stimupy
 
+If you use `stimupy` for your scientific work, please cite the [paper](https://doi.org/10.21105/joss.05321) as:
+
+> Schmittwilken, L., Maertens, M., & Vincent, J. (2023). 
+>   stimupy: A Python package for creating stimuli in vision science.
+>   Journal of Open Source Software, 8(86), 5321.
+>   https://doi.org/10.21105/joss.05321
+
+
+Here is a BibTeX entry for this reference:
+
+```
+@article{Schmittwilken2023,
+    doi = {10.21105/joss.05321},
+    url = {https://doi.org/10.21105/joss.05321},
+    year = {2023},
+    publisher = {The Open Journal},
+    volume = {8},
+    number = {86},
+    pages = {5321},
+    author = {Lynn Schmittwilken and Marianne Maertens and Joris Vincent},
+    title = {stimupy: A Python package for creating stimuli in vision science},
+    journal = {Journal of Open Source Software}
+}
+```
+
+
 ## Your stimulus (set) is not here?
 Given the modular nature of the package,
 any stimulus or stimulus set not currently available, can be easily added.

docs/_toc.yml

@@ -22,6 +22,7 @@ parts:
     - file: reference/demos.md
   - caption: Get in touch
     chapters:
+    - file: contributing/cite
     - file: contributing/get_in_touch
     - file: contributing/contribute
 

docs/contributing/cite.md

@@ -0,0 +1,6 @@
+# Citing stimupy
+
+```{include} ../../README.md
+:start-line: 98
+:end-line: 121
+```

docs/index.md

@@ -7,9 +7,11 @@
 
 ```{include} ../README.md
 :start-line: 28
-:end-line: 42
+:end-line: 41
 ```
 
+---
+
 ::::{grid} 2
 :gutter: 3
 
@@ -60,3 +62,10 @@ request a feature,
 or contribute.
 :::
 ::::
+
+---
+
+```{include} ../README.md
+:start-line: 98
+:end-line: 121
+```