From 7a5f992f4d740413607bfc20c892e00b04beb4e3 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Mon, 20 Nov 2023 11:50:09 -0500 Subject: [PATCH 1/4] 1.0.1 -> 1.0.2 --- README.md | 2 +- docs/index.rst | 2 +- docs/quickstart.rst | 2 +- pyrtools/version.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a3d6377..b1748b4 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/pyrtools/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/pyrtools/actions?query=workflow%3Abuild) [![Documentation Status](https://readthedocs.org/projects/pyrtools/badge/?version=latest)](https://pyrtools.readthedocs.io/en/latest/?badge=latest) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.1?filepath=TUTORIALS%2F) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.2?filepath=TUTORIALS%2F) [![codecov](https://codecov.io/gh/LabForComputationalVision/pyrtools/branch/main/graph/badge.svg?token=Ei9TYftdYi)](https://codecov.io/gh/LabForComputationalVision/pyrtools) Briefly, the tools include: diff --git a/docs/index.rst b/docs/index.rst index 261a4be..de17622 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ :target: https://github.com/LabForComputationalVision/pyrtools/actions?query=workflow%3Abuild .. |binder| image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.1?filepath=TUTORIALS%2F + :target: https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.2?filepath=TUTORIALS%2F .. pyrtools documentation master file, created by sphinx-quickstart on Mon Mar 25 17:57:12 2019. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index c8d29b3..65cea51 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -31,4 +31,4 @@ For more details, see the jupyter notebooks included in the `TUTORIALS/` directory, static versions of which are linked in the navigation sidebar. You can play around with a live version of them in order to test out the code before downloading on `binder -`_ +`_ diff --git a/pyrtools/version.py b/pyrtools/version.py index 20ab5a9..4eda78c 100644 --- a/pyrtools/version.py +++ b/pyrtools/version.py @@ -1 +1 @@ -version = '1.0.1' +version = '1.0.2' From bf1d64d9eb8f969c369a4fcb3c2bc19e2855da04 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Mon, 20 Nov 2023 11:54:34 -0500 Subject: [PATCH 2/4] adds zenodo badges --- README.md | 1 + docs/index.rst | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1748b4..a33ac4a 100644 --- a/README.md +++ b/README.md @@ -5,6 +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/pyrtools/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/pyrtools/actions?query=workflow%3Abuild) [![Documentation Status](https://readthedocs.org/projects/pyrtools/badge/?version=latest)](https://pyrtools.readthedocs.io/en/latest/?badge=latest) +[![DOI](https://zenodo.org/badge/137527035.svg)](https://zenodo.org/doi/10.5281/zenodo.10161031) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.2?filepath=TUTORIALS%2F) [![codecov](https://codecov.io/gh/LabForComputationalVision/pyrtools/branch/main/graph/badge.svg?token=Ei9TYftdYi)](https://codecov.io/gh/LabForComputationalVision/pyrtools) diff --git a/docs/index.rst b/docs/index.rst index de17622..d506196 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,10 @@ .. |binder| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.2?filepath=TUTORIALS%2F - + +.. |doi| image:: https://zenodo.org/badge/137527035.svg + :target: https://zenodo.org/doi/10.5281/zenodo.10161031 + .. pyrtools documentation master file, created by sphinx-quickstart on Mon Mar 25 17:57:12 2019. You can adapt this file completely to your liking, but it should at least @@ -20,7 +23,7 @@ pyrtools ==================================== -|pypi-shield| |license-shield| |python-version-shield| |build| |binder| +|pypi-shield| |license-shield| |python-version-shield| |build| |binder| |doi| Pyrtools is a python package for multi-scale image processing, adapted from Eero Simoncelli's `matlabPyrTools From eb57a05b0b52a4000cbcc16ce670d61cb8da3e79 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Mon, 20 Nov 2023 11:58:53 -0500 Subject: [PATCH 3/4] adds CITATION.cff file --- CITATION.cff | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..97ddc0a --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,23 @@ +cff-version: 1.1.0 +message: "If you use any component of pyrtools, please cite it as below." +authors: +- family-names: Simoncelli + given-names: Eero +- family-names: Young + given-names: Rob +- family-names: Broderick + given-names: William +- family-names: Fiquet + given-names: Pierre-Étienne +- family-names: Wang + given-names: Zhuo +- family-names: Kadkhodaie + given-names: Zahra +- family-names: Parthasarathy + given-names: Nikhil +orcid: https://orcid.org/0000-0000-0000-0000 +title: "Pyrtools: tools for multi-scale image processing" +version: v1.0.2 +date-released: 2023-11-20 +doi: 10.5281/zenodo.10161031 +url: "https://github.com/LabForComputationalVision/pyrtools" From c6a46f15d26d25e2c137fc00c7a252d3597d48f3 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Mon, 20 Nov 2023 12:03:15 -0500 Subject: [PATCH 4/4] adds citation info --- README.md | 9 +++++++++ docs/index.rst | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/README.md b/README.md index a33ac4a..f0ad43d 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,15 @@ pytorch implementation in the [plenoptic](https://github.com/LabForComputationalVision/plenoptic/) package; the implementation in plenoptic is differentiable. +# Citing us + +If you use `pyrtools` in a published academic article or presentation, please +cite us! You can find the link to the most recent release on Zenodo +[here](https://zenodo.org/doi/10.5281/zenodo.10161031) (though please specify +the version you used not the most recent one!). You can also get a formatted +citation at the top right of our [GitHub +repo](https://github.com/LabForComputationalVision/pyrtools) + # Installation It's recommended you install from pip: `pip install pyrtools`. The pip diff --git a/docs/index.rst b/docs/index.rst index d506196..843922e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,6 +42,16 @@ The tools include: **NOTE**: If you are only interested in the complex steerable pyramid, we have a pytorch implementation in the `plenoptic `_ package; the implementation in plenoptic is differentiable. +Citing us +--------- + +If you use ``pyrtools`` in a published academic article or presentation, please +cite us! You can find the link to the most recent release on Zenodo `here +`_ (though please specify the +version you used not the most recent one!). You can also get a formatted +citation at the top right of our `GitHub repo +`_ + .. include:: quickstart.rst Pyramid resources