From eec0998a5afd623aad0e4580ffaf67b84736568c Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 15:47:01 -0400 Subject: [PATCH 1/9] adds pypi deploy action --- .github/workflows/deploy.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000..e71113a0 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,25 @@ +name: deploy +on: + release: + types: [published] + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build --outdir dist/ --sdist + - name: Publish package to test pypi + uses: pypa/gh-action-pypi-publish@release/v1 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} From 2478dfdbffbb4a64d8a8f715c0ea9ab82a6ea3fb Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 15:47:39 -0400 Subject: [PATCH 2/9] adds pypi badges --- README.md | 1 + docs/index.rst | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04f2d6a9..27a55c60 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # plenoptic +[![PyPI Version](https://img.shields.io/pypi/v/plenoptic.svg)](https://pypi.org/project/plenoptic/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/LabForComputationalVision/plenoptic/blob/main/LICENSE) ![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) diff --git a/docs/index.rst b/docs/index.rst index ba350d6b..b37859c5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,6 @@ +.. |pypi-shield| image:: https://img.shields.io/pypi/v/plenoptic.svg + :target: https://pypi.org/project/plenoptic/ + .. |license-shield| image:: https://img.shields.io/badge/license-MIT-yellow.svg :target: https://github.com/LabForComputationalVision/plenoptic/blob/main/LICENSE @@ -21,7 +24,7 @@ plenoptic ********* -|license-shield| |python-version-shield| |build| |tutorials| |zenodo| +|pypi-shield| |license-shield| |python-version-shield| |build| |tutorials| |zenodo| .. image:: images/plenoptic_logo_wide.svg :align: center From e1b8d2d3d55e17fbdc27fdab65f61840b5e4ad00 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 15:47:48 -0400 Subject: [PATCH 3/9] updates binder badges to v0.2 --- README.md | 2 +- docs/index.rst | 5 ++++- docs/install.rst | 2 +- examples/02_Eigendistortions.ipynb | 2 +- examples/04_Perceptual_distance.ipynb | 2 +- examples/Demo_Eigendistortion.ipynb | 2 +- examples/README.md | 2 +- 7 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 27a55c60..0b051127 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3995057.svg)](https://doi.org/10.5281/zenodo.3995057) [![codecov](https://codecov.io/gh/LabForComputationalVision/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/LabForComputationalVision/plenoptic) [![Tutorials Status](https://github.com/LabForComputationalVision/plenoptic/workflows/tutorials/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Atutorials) -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/main?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples) ![](docs/images/plenoptic_logo_wide.svg) diff --git a/docs/index.rst b/docs/index.rst index b37859c5..f628f548 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,9 @@ .. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3995057.svg :target: https://doi.org/10.5281/zenodo.3995057 +.. |binder| image:: https://mybinder.org/badge_logo.svg + :target: https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples + .. plenoptic documentation master file, created by sphinx-quickstart on Thu Jun 20 15:56:27 2019. You can adapt this file completely to your liking, but it should at least @@ -24,7 +27,7 @@ plenoptic ********* -|pypi-shield| |license-shield| |python-version-shield| |build| |tutorials| |zenodo| +|pypi-shield| |license-shield| |python-version-shield| |build| |tutorials| |zenodo| |binder| .. image:: images/plenoptic_logo_wide.svg :align: center diff --git a/docs/install.rst b/docs/install.rst index b139899c..c734c053 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -46,7 +46,7 @@ Jupyter If you wish to locally run the notebooks, you will need to install ``jupyter`` and ``ipywidgets`` (you can also run them in the cloud using `Binder -`_). +`_). There are two main ways of getting a local `jupyter` install` working with this package: diff --git a/examples/02_Eigendistortions.ipynb b/examples/02_Eigendistortions.ipynb index c697bc47..a72c9772 100644 --- a/examples/02_Eigendistortions.ipynb +++ b/examples/02_Eigendistortions.ipynb @@ -10,7 +10,7 @@ "source": [ "# Eigendistortions\n", "\n", - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/master?filepath=examples/02_Eigendistortions.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/02_Eigendistortions.ipynb)\n", "\n", "**In this tutorial we will cover:**\n", "\n", diff --git a/examples/04_Perceptual_distance.ipynb b/examples/04_Perceptual_distance.ipynb index 243198ba..85294829 100644 --- a/examples/04_Perceptual_distance.ipynb +++ b/examples/04_Perceptual_distance.ipynb @@ -7,7 +7,7 @@ "source": [ "# Perceptual distance\n", "\n", - "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/master?filepath=examples/04_Perceptual_distance.ipynb)\n", + "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/04_Perceptual_distance.ipynb)\n", "\n", "The easiest way to measure the difference between two images is by computing the mean square error (MSE), but it does not match the perceptual distance judged by humans. Several perceptual distance functions have been developed to better match human perception. This tutorial introduces three perceptual distance functions available in `plenoptic` package: SSIM (structural similarity), MS-SSIM (multiscale structural similarity) and NLPD (normalized Laplacian pyramid distance).\n", "\n", diff --git a/examples/Demo_Eigendistortion.ipynb b/examples/Demo_Eigendistortion.ipynb index 49558de2..0174d612 100644 --- a/examples/Demo_Eigendistortion.ipynb +++ b/examples/Demo_Eigendistortion.ipynb @@ -8,7 +8,7 @@ } }, "source": [ - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/master?filepath=examples/Demo_Eigendistortion.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/Demo_Eigendistortion.ipynb)\n", "\n", "# Reproducing Berardino et al., 2017 (Eigendistortions)\n", "Author: Lyndon Duong, Jan 2021\n", diff --git a/examples/README.md b/examples/README.md index 958b563c..a3d7908e 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Plenoptic example notebooks -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/main?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples) Browse, preview, and run these notebooks in your browser without installing ``plenoptic.py`` using the ``launch Binder`` button above. From 99d0876d68d2154652a36959b50d7f775811f012 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 15:49:07 -0400 Subject: [PATCH 4/9] updates version.py to 0.2.0 --- plenoptic/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plenoptic/version.py b/plenoptic/version.py index 75b8a57b..60fb6a57 100644 --- a/plenoptic/version.py +++ b/plenoptic/version.py @@ -1 +1 @@ -version = '0.1.0' +version = '0.2.0' From 682162341c4619f62b9217261eade5286609f463 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 15:50:50 -0400 Subject: [PATCH 5/9] updates pip install in installation instructions --- README.md | 5 ++--- docs/index.rst | 5 ++--- docs/install.rst | 2 +- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0b051127..9fe1a0ef 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,10 @@ experiments for further investigation. ### Installation -The best way to install `plenoptic` is via `pip`. For now, you must do -this from github directly: +The best way to install `plenoptic` is via `pip`. ``` bash -$ pip install git+https://github.com/LabForComputationalVision/plenoptic.git +$ pip install plenoptic ``` See the [installation diff --git a/docs/index.rst b/docs/index.rst index f628f548..80bd8e68 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,10 +53,9 @@ Installation .. highlight:: bash -The best way to install ``plenoptic`` is via ``pip``. For now, you must do this -from github directly:: +The best way to install ``plenoptic`` is via ``pip``. -$ pip install git+https://github.com/LabForComputationalVision/plenoptic.git +$ pip install plenoptic See the :ref:`install` page for more details, including how to set up an isolated virtual environment (recommended). diff --git a/docs/install.rst b/docs/install.rst index c734c053..307af4ca 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -14,7 +14,7 @@ installed on your machine, I recommend starting with `miniconda $ conda create --name plenoptic pip python=3.9 $ conda activate plenoptic -$ pip install git+https://github.com/LabForComputationalVision/plenoptic.git +$ pip install plenoptic You can also install it directly from source:: From 2f1b25ae1f4693b083be19a6a17adf1fbff8d22d Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 16:22:44 -0400 Subject: [PATCH 6/9] updates CONTRIBUTING with release info --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d37cea9a..85de6e6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,40 @@ objects](https://plenoptic.readthedocs.io/en/latest/synthesis.html). Any new models or synthesis objects will need to meet the requirements outlined in those pages. +### Releases + +We create releases on Github, deploy on / distribute via +[pypi](https://pypi.org/), and try to follow [semantic +versioning](https://semver.org/): + +> Given a version number MAJOR.MINOR.PATCH, increment the: +> 1. MAJOR version when you make incompatible API changes +> 2. MINOR version when you add functionality in a backward compatible manner +> 3. PATCH version when you make backward compatible bug fixes + +When doing a new release, the following steps must be taken: +1. In a new PR: + - Update the string in `version.py`. This will update the value used in + `setup.py`. It should be of the format `X.Y.Z`, where `X,Y,Z` are all + integers. + - Update all the [binder](https://mybinder.org) links, which are of the form + `https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v{X.Y.Z}?filepath=examples`, + which are found in `README.md`, `index.rst`, `examples/README.md`, and some + of the tutorial notebooks found in `examples/`. Note that the version tag + has to match the github tag (specified in the next step), which should match + the value found in `version.py` with `v` prepended. +2. After merging the above PR into the `main` branch, [create a Github + release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) + with a new tag matching that used in the binder link above: `v{X.Y.Z}`. + Creating the release will trigger the deployment to pypi, via our `deploy` + action (found in `.github/workflows/deploy.yml`). + +Note that the binder link must match the GitHub tag, but the pypi version is +based on `version.py`. I have been unable to find a way to link them directly +(or make [binder](https://mybinder.org) use a `latest` tag, like +[readthedocs](https://readthedocs.org/) does), so we need to manually ensure +they match. + ## Testing Before running tests locally, you'll need From 5ad126e6537718ceebd39e812405fee087b3877b Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 16:24:53 -0400 Subject: [PATCH 7/9] change tag from 0.2 to 1.0.0 that's the correct version tag --- README.md | 2 +- docs/index.rst | 2 +- docs/install.rst | 2 +- examples/02_Eigendistortions.ipynb | 2 +- examples/04_Perceptual_distance.ipynb | 2 +- examples/Demo_Eigendistortion.ipynb | 2 +- examples/README.md | 2 +- plenoptic/version.py | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9fe1a0ef..cd0e5d2b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3995057.svg)](https://doi.org/10.5281/zenodo.3995057) [![codecov](https://codecov.io/gh/LabForComputationalVision/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/LabForComputationalVision/plenoptic) [![Tutorials Status](https://github.com/LabForComputationalVision/plenoptic/workflows/tutorials/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Atutorials) -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples) ![](docs/images/plenoptic_logo_wide.svg) diff --git a/docs/index.rst b/docs/index.rst index 80bd8e68..f28102fc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ :target: https://doi.org/10.5281/zenodo.3995057 .. |binder| image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples + :target: https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples .. plenoptic documentation master file, created by sphinx-quickstart on Thu Jun 20 15:56:27 2019. diff --git a/docs/install.rst b/docs/install.rst index 307af4ca..b2f6baf4 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -46,7 +46,7 @@ Jupyter If you wish to locally run the notebooks, you will need to install ``jupyter`` and ``ipywidgets`` (you can also run them in the cloud using `Binder -`_). +`_). There are two main ways of getting a local `jupyter` install` working with this package: diff --git a/examples/02_Eigendistortions.ipynb b/examples/02_Eigendistortions.ipynb index a72c9772..9514e446 100644 --- a/examples/02_Eigendistortions.ipynb +++ b/examples/02_Eigendistortions.ipynb @@ -10,7 +10,7 @@ "source": [ "# Eigendistortions\n", "\n", - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/02_Eigendistortions.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/02_Eigendistortions.ipynb)\n", "\n", "**In this tutorial we will cover:**\n", "\n", diff --git a/examples/04_Perceptual_distance.ipynb b/examples/04_Perceptual_distance.ipynb index 85294829..8a8317c8 100644 --- a/examples/04_Perceptual_distance.ipynb +++ b/examples/04_Perceptual_distance.ipynb @@ -7,7 +7,7 @@ "source": [ "# Perceptual distance\n", "\n", - "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/04_Perceptual_distance.ipynb)\n", + "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/04_Perceptual_distance.ipynb)\n", "\n", "The easiest way to measure the difference between two images is by computing the mean square error (MSE), but it does not match the perceptual distance judged by humans. Several perceptual distance functions have been developed to better match human perception. This tutorial introduces three perceptual distance functions available in `plenoptic` package: SSIM (structural similarity), MS-SSIM (multiscale structural similarity) and NLPD (normalized Laplacian pyramid distance).\n", "\n", diff --git a/examples/Demo_Eigendistortion.ipynb b/examples/Demo_Eigendistortion.ipynb index 0174d612..ed17a199 100644 --- a/examples/Demo_Eigendistortion.ipynb +++ b/examples/Demo_Eigendistortion.ipynb @@ -8,7 +8,7 @@ } }, "source": [ - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples/Demo_Eigendistortion.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/Demo_Eigendistortion.ipynb)\n", "\n", "# Reproducing Berardino et al., 2017 (Eigendistortions)\n", "Author: Lyndon Duong, Jan 2021\n", diff --git a/examples/README.md b/examples/README.md index a3d7908e..d499686f 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Plenoptic example notebooks -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v0.2?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples) Browse, preview, and run these notebooks in your browser without installing ``plenoptic.py`` using the ``launch Binder`` button above. diff --git a/plenoptic/version.py b/plenoptic/version.py index 60fb6a57..de43469d 100644 --- a/plenoptic/version.py +++ b/plenoptic/version.py @@ -1 +1 @@ -version = '0.2.0' +version = '1.0.0' From 42d63753ef33298fdb73e07131706d2a5e1f8a22 Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 16:45:36 -0400 Subject: [PATCH 8/9] binder tag v1.0.0 -> 1.0.0 --- CONTRIBUTING.md | 10 +++++----- README.md | 2 +- docs/index.rst | 2 +- docs/install.rst | 2 +- examples/02_Eigendistortions.ipynb | 2 +- examples/04_Perceptual_distance.ipynb | 2 +- examples/Demo_Eigendistortion.ipynb | 2 +- examples/README.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85de6e6b..7740347e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -109,17 +109,17 @@ versioning](https://semver.org/): When doing a new release, the following steps must be taken: 1. In a new PR: - Update the string in `version.py`. This will update the value used in - `setup.py`. It should be of the format `X.Y.Z`, where `X,Y,Z` are all + `setup.py`. It should be of the format `X.Y.Z`, where `X`, `Y`, `Z` are all integers. - Update all the [binder](https://mybinder.org) links, which are of the form - `https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v{X.Y.Z}?filepath=examples`, + `https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/X.Y.Z?filepath=examples`, which are found in `README.md`, `index.rst`, `examples/README.md`, and some of the tutorial notebooks found in `examples/`. Note that the version tag - has to match the github tag (specified in the next step), which should match - the value found in `version.py` with `v` prepended. + must match the github tag (specified in the next step) or the link won't + work, and this github tag should match the value found in `version.py`. 2. After merging the above PR into the `main` branch, [create a Github release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) - with a new tag matching that used in the binder link above: `v{X.Y.Z}`. + with a new tag matching that used in the binder link above: `X.Y.Z`. Creating the release will trigger the deployment to pypi, via our `deploy` action (found in `.github/workflows/deploy.yml`). diff --git a/README.md b/README.md index cd0e5d2b..bf216fb0 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3995057.svg)](https://doi.org/10.5281/zenodo.3995057) [![codecov](https://codecov.io/gh/LabForComputationalVision/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/LabForComputationalVision/plenoptic) [![Tutorials Status](https://github.com/LabForComputationalVision/plenoptic/workflows/tutorials/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Atutorials) -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples) ![](docs/images/plenoptic_logo_wide.svg) diff --git a/docs/index.rst b/docs/index.rst index f28102fc..f9828299 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ :target: https://doi.org/10.5281/zenodo.3995057 .. |binder| image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples + :target: https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples .. plenoptic documentation master file, created by sphinx-quickstart on Thu Jun 20 15:56:27 2019. diff --git a/docs/install.rst b/docs/install.rst index b2f6baf4..a36b6144 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -46,7 +46,7 @@ Jupyter If you wish to locally run the notebooks, you will need to install ``jupyter`` and ``ipywidgets`` (you can also run them in the cloud using `Binder -`_). +`_). There are two main ways of getting a local `jupyter` install` working with this package: diff --git a/examples/02_Eigendistortions.ipynb b/examples/02_Eigendistortions.ipynb index 9514e446..4ece535d 100644 --- a/examples/02_Eigendistortions.ipynb +++ b/examples/02_Eigendistortions.ipynb @@ -10,7 +10,7 @@ "source": [ "# Eigendistortions\n", "\n", - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/02_Eigendistortions.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples/02_Eigendistortions.ipynb)\n", "\n", "**In this tutorial we will cover:**\n", "\n", diff --git a/examples/04_Perceptual_distance.ipynb b/examples/04_Perceptual_distance.ipynb index 8a8317c8..c6f87d86 100644 --- a/examples/04_Perceptual_distance.ipynb +++ b/examples/04_Perceptual_distance.ipynb @@ -7,7 +7,7 @@ "source": [ "# Perceptual distance\n", "\n", - "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/04_Perceptual_distance.ipynb)\n", + "**Run notebook online with Binder:** [![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples/04_Perceptual_distance.ipynb)\n", "\n", "The easiest way to measure the difference between two images is by computing the mean square error (MSE), but it does not match the perceptual distance judged by humans. Several perceptual distance functions have been developed to better match human perception. This tutorial introduces three perceptual distance functions available in `plenoptic` package: SSIM (structural similarity), MS-SSIM (multiscale structural similarity) and NLPD (normalized Laplacian pyramid distance).\n", "\n", diff --git a/examples/Demo_Eigendistortion.ipynb b/examples/Demo_Eigendistortion.ipynb index ed17a199..51c3fd3f 100644 --- a/examples/Demo_Eigendistortion.ipynb +++ b/examples/Demo_Eigendistortion.ipynb @@ -8,7 +8,7 @@ } }, "source": [ - "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples/Demo_Eigendistortion.ipynb)\n", + "**Run notebook online with Binder:**[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples/Demo_Eigendistortion.ipynb)\n", "\n", "# Reproducing Berardino et al., 2017 (Eigendistortions)\n", "Author: Lyndon Duong, Jan 2021\n", diff --git a/examples/README.md b/examples/README.md index d499686f..8dc48f91 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Plenoptic example notebooks -[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/v1.0.0?filepath=examples) +[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.0?filepath=examples) Browse, preview, and run these notebooks in your browser without installing ``plenoptic.py`` using the ``launch Binder`` button above. From 4703f1d365d5d3b69aa3a015f4da2b262782f47d Mon Sep 17 00:00:00 2001 From: "William F. Broderick" Date: Thu, 18 May 2023 17:22:56 -0400 Subject: [PATCH 9/9] updates long_description in setup.py --- setup.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index ff31b01f..16e9c9ba 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,9 @@ def readlines(fn): setup( name="plenoptic", version=VERSION, - description="Visual Information Processing", + long_description=open('README.md', 'r').read(), + long_description_content_type='text/markdown', + description="Python library for model-based stimulus synthesis.", license="MIT", url="https://github.com/LabForComputationalVision/plenoptic", author="LabForComputationalVision",