Merge pull request #122 from PyLops/dev

Release v0.6.0

Author: mrava87

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "3.9"
   apt_packages:
     - libopenblas-dev
 

CHANGELOG.md

@@ -1,9 +1,19 @@
+# 0.6.0
+
+:vertical_traffic_light: :vertical_traffic_light: This is the first release supporting PyLops v2.
+:vertical_traffic_light: :vertical_traffic_light:
+
+* Added ``grad`` method to ``pyproximal.utils.bilinear.LowRankFactorizedMatrix`` operator
+* Allow passing optional arguments to solvers in ``pyproximal.proximal.L2``
+* Modified codebase to integrate with pylops's ``cupy`` backend.
+* Modified codebase to integrate with ``pylops`` v2.
+
 # 0.5.0
 
 :vertical_traffic_light: :vertical_traffic_light: This is the latest release supporting PyLops v1.
 :vertical_traffic_light: :vertical_traffic_light:
 
-* Added  ``pyproximal.proximal.Log1`` operator
+* Added ``pyproximal.proximal.Log1`` operator
 * Allow ``radius`` parameter of ``pyproximal.optimization.primal.L0`` to be a function
 * Allow ``tau`` parameter of ``pyproximal.optimization.primal.HQS`` to be a vector
   and change over iterations

Makefile

@@ -40,3 +40,12 @@ doc:
 
 docupdate:
 	cd docs && make html && cd ..
+
+servedoc:
+	$(PYTHON) -m http.server --directory docs/build/html/
+
+lint:
+	flake8 docs/ examples/ pyproximal/ pytests/ tutorials/
+
+typeannot:
+	mypy pyproximal/

docs/source/_templates/breadcrumbs.html

@@ -3,6 +3,18 @@
 Changelog
 =========
 
+Version 0.6.0
+--------------
+*Released on: 18/03/2023*
+
+|:vertical_traffic_light:| |:vertical_traffic_light:| This is the first release supporting PyLops v2.
+|:vertical_traffic_light:| |:vertical_traffic_light:|
+
+* Added ``grad`` method to :py:class:`pyproximal.utils.bilinear.LowRankFactorizedMatrix` operator
+* Allow passing optional arguments to solvers in :py:class:`pyproximal.proximal.L2`
+* Modified codebase to integrate with pylops's ``cupy`` backend.
+* Modified codebase to integrate with ``pylops`` v2.
+
 Version 0.5.0
 --------------
 *Released on: 20/08/2022*

docs/source/changelog.rst

@@ -98,12 +98,12 @@
 .. |year| replace:: {year}
 """.format(year=year)
 
+html_static_path = ["_static"]
 html_last_updated_fmt = '%b %d, %Y'
 html_title = 'PyProximal'
 html_short_title = 'PyProximal'
-html_logo = '_static/pyproximal.png'
-html_favicon = '_static/favicon.ico'
-html_static_path = ['_static']
+html_logo = 'pyproximal.png'
+html_favicon = 'favicon.ico'
 html_extra_path = []
 pygments_style = 'default'
 add_function_parentheses = False
@@ -112,7 +112,7 @@
 html_show_copyright = True
 
 # Theme config
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     'logo_only': True,
     'display_version': True,

docs/source/conf.py

@@ -6,8 +6,8 @@ Installation
 To install the PyProximal library you will need **Python 3.8 or greater**.
 
 .. note::
-    Versions prior to v0.3.0 work alsi with Python 3.6 or greater, however they
-    require scipy version to be lower than v1.8.0
+    Versions prior to v0.3.0 require Python 3.6 or greater, and scipy version
+    lower than v1.8.0.
 
 Dependencies
 ------------

docs/source/installation.rst

@@ -7,7 +7,7 @@ dependencies:
   - python>=3.8.12
   - numpy>=1.15.0
   - scipy>=1.8.0
-  - pylops<2.0.0
+  - pylops>=2.0.0
   - scikit-image
   - matplotlib
   - ipython

environment-dev.yml

@@ -5,4 +5,4 @@ dependencies:
   - python>=3.8.12
   - numpy>=1.15.0
   - scipy>=1.8.0
-  - pylops<2.0.0
+  - pylops>=2.0.0

environment.yml

@@ -111,7 +111,7 @@ def PlugAndPlay(proxf, denoiser, dims, x0, tau, niter=10,
        "Plug-and-Play priors for model based reconstruction",
        IEEE. 2013.
 
-    .. [1] Meinhardt, T., Moeller, M, Hazirbas, C., and Cremer, D.
+    .. [2] Meinhardt, T., Moeller, M, Hazirbas, C., and Cremer, D.
        "Learning Proximal Operators: Using Denoising Networks for Regularizing Inverse Imaging Problems",
        arXiv. 2017.