From 7b3cbe8e312401b3d549ba49bfe9e78437ef3edf Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Tue, 20 Feb 2024 12:47:33 -0500 Subject: [PATCH 1/3] updates citation discussion --- README.md | 21 ++++++++++++++++++++- docs/citation.rst | 24 ++++++++++++++++++++---- 2 files changed, 40 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 829bb517..c59d3689 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/citation.rst b/docs/citation.rst index 6b91b2aa..b2694234 100644 --- a/docs/citation.rst +++ b/docs/citation.rst @@ -1,13 +1,29 @@ +.. |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:: + + @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]_. From 6b3ae32865f18a0a2fde392c10bcc01ce13573e8 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Tue, 20 Feb 2024 12:48:47 -0500 Subject: [PATCH 2/3] fixes readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c59d3689..9bf3de5a 100644 --- a/README.md +++ b/README.md @@ -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) @@ -150,7 +150,7 @@ the code, or use the following: } ``` -! See the [citation +See the [citation guide](https://plenoptic.readthedocs.io/en/latest/citation.html) for more details. From a0d1c018be6e68eaf22778f1937af4dcc9b2471e Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Tue, 20 Feb 2024 13:00:17 -0500 Subject: [PATCH 3/3] fix syntas highlighting --- docs/citation.rst | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/citation.rst b/docs/citation.rst index b2694234..3d673b54 100644 --- a/docs/citation.rst +++ b/docs/citation.rst @@ -10,18 +10,20 @@ 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:: - - @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} - } +- 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 cite the following paper(s) depending on which component you use: