Skip to content

Commit

Permalink
Merge pull request #89 from computational-psychology/dev_manuscript
Browse files Browse the repository at this point in the history
docs: final touchup on manuscript
  • Loading branch information
JorisVincent committed Jun 7, 2023
2 parents f756c54 + c3d999c commit ca8bf43
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion manuscript/bibliography.bib
Expand Up @@ -127,7 +127,7 @@ @article{murray2020
number = {7},
pages = {28},
issn = {1534-7362},
doi = {10/gh57gf}
doi = {10.1167/jov.20.7.28}
}

@article{murray2021,
Expand Down
15 changes: 12 additions & 3 deletions manuscript/paper.md
Expand Up @@ -47,7 +47,7 @@ of different complexity as they are commonly used in the study of visual percept
- visual [stimuli](https://stimupy.readthedocs.io/en/latest/reference/_api/stimupy.stimuli.html)
such as Gabors, plaids, edges, and a variety of so-called illusions
(e.g., Simultaneous Brightness Contrast, White's illusion, Hermann grid, Ponzo illusion), and many more
- stimulus sets from prior research papers, providing exact stimulus recreations (e.g., ModelFest, @carney1999)
- stimulus sets from prior research [papers](https://stimupy.readthedocs.io/en/latest/reference/_api/stimupy.papers.html), providing exact stimulus recreations (e.g., ModelFest, @carney1999)
- [utility functions](https://stimupy.readthedocs.io/en/latest/reference/_api/stimupy.utils.html)
for stimulus import, export, manipulation (e.g., contrast, size), or plotting
- [documentation](https://stimupy.readthedocs.io/en/latest/index.html),
Expand Down Expand Up @@ -128,7 +128,7 @@ Both packages also have a strong focus on ease-of-use, replicability, and open s
`stimupy` currently focuses on a different class of stimuli:
mainly displays used to study early and low-level visual processes,
as well as visual features such as brightness, contrast, and orientation.
Thus, OCTA and `stimupy` cover complementary usecases.
Thus, OCTA and `stimupy` cover complementary use cases.

Another design decision that sets `stimupy` apart from existing software such as OCTA and Pyllusion,
is that all `stimupy` stimuli are generated as `NumPy`-arrays
Expand Down Expand Up @@ -171,7 +171,7 @@ As far as we know `stimupy` is the only package that:

`stimupy` is a free and open-source Python package
which can be easily downloaded and installed via standard package managers,
or directly from its GitHub source.
or directly from its [GitHub source](https://github.com/computational-psychology/stimupy).
We think that using `stimupy` will improve the consistency
and accessibility of visual stimuli while helping to avoid bugs.
A key feature in `stimupy` is that its functions are parameterized
Expand All @@ -195,6 +195,15 @@ for other purposes than psychophysical experimentation on a computer screen
The main advantage of using dictionaries as function outputs is that
Python dictionaries are mutable data structures
which allow you to add additional information easily.
Moreover, the stimulus dictionaries contain all parameter information
relevant for describing a stimulus (e.g., size, resolution, spatial
frequency, orientation, phase, etc), and hence help to report
stimulus parameters, e.g. in a research paper.
`stimupy` also provides utility-functions to strip the stimulus dictionaries down
to just the raw parameters that the original stimulus function expects.
Hence, it is sufficient to share only the stimulus dictionaries to recreate
exact stimulus replications, which makes it easy to create slight variations of
this stimulus.
Taken together,
these design choices make `stimupy` a flexible and versatile Python package
which facilitates the (re)creation and use of visual stimuli for a variety of purposes.
Expand Down

0 comments on commit ca8bf43

Please sign in to comment.