Skip to content

Commit c6a46f1

Browse files
committed
adds citation info
1 parent eb57a05 commit c6a46f1

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ pytorch implementation in the
3030
[plenoptic](https://github.com/LabForComputationalVision/plenoptic/) package;
3131
the implementation in plenoptic is differentiable.
3232

33+
# Citing us
34+
35+
If you use `pyrtools` in a published academic article or presentation, please
36+
cite us! You can find the link to the most recent release on Zenodo
37+
[here](https://zenodo.org/doi/10.5281/zenodo.10161031) (though please specify
38+
the version you used not the most recent one!). You can also get a formatted
39+
citation at the top right of our [GitHub
40+
repo](https://github.com/LabForComputationalVision/pyrtools)
41+
3342
# Installation
3443

3544
It's recommended you install from pip: `pip install pyrtools`. The pip

docs/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@ The tools include:
4242

4343
**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.
4444

45+
Citing us
46+
---------
47+
48+
If you use ``pyrtools`` in a published academic article or presentation, please
49+
cite us! You can find the link to the most recent release on Zenodo `here
50+
<https://zenodo.org/doi/10.5281/zenodo.10161031>`_ (though please specify the
51+
version you used not the most recent one!). You can also get a formatted
52+
citation at the top right of our `GitHub repo
53+
<https://github.com/LabForComputationalVision/pyrtools>`_
54+
4555
.. include:: quickstart.rst
4656

4757
Pyramid resources

0 commit comments

Comments
 (0)