Skip to content

Commit

Permalink
docs: added citation to readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LynnSchmittwilken committed Jun 16, 2023
1 parent ca8bf43 commit 6279322
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Expand Up @@ -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

Expand All @@ -97,6 +97,30 @@ 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 formatted 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.
Expand Down
5 changes: 5 additions & 0 deletions docs/index.md
Expand Up @@ -10,6 +10,11 @@
:end-line: 42
```

```{include} ../README.md
:start-line: 98
:end-line: 121
```

::::{grid} 2
:gutter: 3

Expand Down

0 comments on commit 6279322

Please sign in to comment.