Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Citation update #249

Merged
merged 3 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![Python version](https://img.shields.io/badge/python-3.7|3.8|3.9|3.10-blue.svg)
[![Build Status](https://github.com/LabForComputationalVision/plenoptic/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Abuild)
[![Documentation Status](https://readthedocs.org/projects/plenoptic/badge/?version=latest)](https://plenoptic.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/doi/10.5281/zenodo.10151130)](https://doi.org/10.5281/zenodo.10151130)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10151131.svg)](https://doi.org/10.5281/zenodo.10151131)
[![codecov](https://codecov.io/gh/LabForComputationalVision/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/LabForComputationalVision/plenoptic)
[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.1?filepath=examples)

Expand Down Expand Up @@ -131,7 +131,26 @@ In all cases, please follow our [code of conduct](CODE_OF_CONDUCT.md).
## Citing us

If you use `plenoptic` in a published academic article or presentation, please
cite us! See the [citation
cite both the code by the DOI as well the JOV paper. You can click on `Cite this
repository` on the right side of the GitHub page to get a copyable citation for
the code, or use the following:

- Code: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10151131.svg)](https://doi.org/10.5281/zenodo.10151131)
- Paper:
``` bibtex
@article{duong2023plenoptic,
title={Plenoptic: A platform for synthesizing model-optimized visual stimuli},
author={Duong, Lyndon and Bonnen, Kathryn and Broderick, William and Fiquet, Pierre-{\'E}tienne and Parthasarathy, Nikhil and Yerxa, Thomas and Zhao, Xinyuan and Simoncelli, Eero},
journal={Journal of Vision},
volume={23},
number={9},
pages={5822--5822},
year={2023},
publisher={The Association for Research in Vision and Ophthalmology}
}
```

See the [citation
guide](https://plenoptic.readthedocs.io/en/latest/citation.html) for more
details.

Expand Down
26 changes: 22 additions & 4 deletions docs/citation.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,31 @@
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10151130.svg
:target: https://zenodo.org/doi/10.5281/zenodo.10151130

.. _citation:

Citation Guide
**************

If you use ``plenoptic`` in a published piece of academic work, please cite
[VSS2023]_ (and check this guide again before publishing, as we are planning on
having a paper to cite instead of the current presentation).
If you use ``plenoptic`` in a published academic article or presentation, please
cite both the code by the DOI as well [VSS2023]_. You can use the following:

- Code: |zenodo|
- Paper:

.. code-block:: bibtex

@article{duong2023plenoptic,
title={Plenoptic: A platform for synthesizing model-optimized visual stimuli},
author={Duong, Lyndon and Bonnen, Kathryn and Broderick, William and Fiquet, Pierre-{\'E}tienne and Parthasarathy, Nikhil and Yerxa, Thomas and Zhao, Xinyuan and Simoncelli, Eero},
journal={Journal of Vision},
volume={23},
number={9},
pages={5822--5822},
year={2023},
publisher={The Association for Research in Vision and Ophthalmology}
}

Additionally, please additionally cite the following paper(s) depending on which
Additionally, please cite the following paper(s) depending on which
component you use:

- :class:`plenoptic.synthesize.metamer.Metamer`: or :class:`plenoptic.synthesize.metamer.MetamerCTF`: [Portilla2000]_.
Expand Down
Loading