Merge pull request #25 from LabForComputationalVision/release_1.0.2

Release 1.0.2 updates

Author: billbrod

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"

README.md

@@ -5,7 +5,8 @@
 ![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)
+[![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)
 
 Briefly, the tools include:
@@ -29,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

docs/index.rst

@@ -10,8 +10,11 @@
 		     :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
+
+.. |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
@@ -39,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 <https://plenoptic.readthedocs.io/en/>`_ 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>`_
+
 .. include:: quickstart.rst
 
 Pyramid resources

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
-<https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.1?filepath=TUTORIALS%2F>`_
+<https://mybinder.org/v2/gh/LabForComputationalVision/pyrtools/v1.0.2?filepath=TUTORIALS%2F>`_

pyrtools/version.py

@@ -1 +1 @@
-version = '1.0.1'
+version = '1.0.2'