Merge pull request #499 from PyLops/dev

Merge for v2.1.0

Author: mrava87

.github/workflows/build.yaml

@@ -4,16 +4,16 @@ on: [push, pull_request]
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        platform: [ ubuntu-latest, macos-latest ]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
+    runs-on: ${{ matrix.platform }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/codacy-coverage-reporter.yaml

@@ -0,0 +1,33 @@
+# This workflow uploads PyLops coverage analysis on Codacy
+# For more information see: https://github.com/codacy/codacy-coverage-reporter-action
+name: PyLops-coverage
+
+on: [push, pull_request_target]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest coverage
+        if [ -f requirements.txt ]; then pip install -r requirements-dev.txt; fi
+    - name: Install pylops
+      run: |
+        pip install .
+    - name: Code coverage with coverage
+      run: |
+        coverage run -m pytest
+        coverage xml
+    - name: Run codacy-coverage-reporter
+      uses: codacy/codacy-coverage-reporter-action@v1
+      with:
+        project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        coverage-reports: coverage.xml

.github/workflows/flake8.yaml

@@ -10,9 +10,9 @@ jobs:
     name: Lint
     steps:
       - name: Check out source repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Python environment
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.8"
       - name: flake8 Lint

.travis.yml

@@ -1,3 +1,18 @@
+# 2.1.0
+* Added `pylops.signalprocessing.DCT`, `pylops.signalprocessing.NonStationaryConvolve1D`,
+  `pylops.signalprocessing.NonStationaryConvolve2D`, `pylops.signalprocessing.NonStationaryFilters1D`, and
+  `pylops.signalprocessing.NonStationaryFilters2D` operators
+* Added `pylops.waveeqprocessing.BlendingContinuous`, `pylops.waveeqprocessing.BlendingGroup`, and
+  `pylops.waveeqprocessing.BlendingHalf` operators
+* Added `kind='datamodel'` to `pylops.optimization.cls_sparsity.IRLS`
+* Improved inner working of `pylops.waveeqprocessing.Kirchhoff` operator significantly
+  reducing the memory usage related to storing traveltime, angle, and amplitude tables.
+* Improved handling of `haxes` in `pylops.signalprocessing.Radon2D` and `pylops.signalprocessing.Radon3D` operators
+* Added possibility to feed ND-arrays to `pylops.TorchOperator`
+* Removed `pylops.LinearOperator` inheritance and added `__call__` method to `pylops.TorchOperator`
+* Removed `scipy.sparse.linalg.LinearOperator` and added `abc.ABC` inheritance to `pylops.LinearOperator`
+* All operators are now classes of `pylops.LinearOperator` type
+
 # 2.0.0
 PyLops has undergone significant changes in this release, including new ``LinearOperator``s, more features, new examples and bugfixes.
 To aid users in navigating the breaking changes, we provide the following document [MIGRATION_V1_V2.md](https://github.com/PyLops/pylops/blob/dev/MIGRATION_V1_V2.md).

CHANGELOG.md

@@ -40,8 +40,14 @@ doc:
 docupdate:
 	cd docs && make html && cd ..
 
+servedoc:
+	$(PYTHON) -m http.server --directory docs/build/html/
+
 lint:
 	flake8 docs/ examples/ pylops/ pytests/ tutorials/
 
 typeannot:
 	mypy pylops/
+
+coverage:
+	coverage run -m pytest && coverage xml && coverage html && $(PYTHON) -m http.server --directory htmlcov/

Makefile

@@ -142,3 +142,8 @@ A list of video tutorials to learn more about PyLops:
 * Alan Richardson, ar4
 * BurningKarl, BurningKarl
 * Nick Luiken, NickLuiken
+* BurningKarl, BurningKarl
+* Muhammad Izzatullah, izzatum
+* Juan Daniel Romero, jdromerom
+* Aniket Singh Rawat, dikwickley
+* Rohan Babbar, rohanbabbar04

README.md

@@ -0,0 +1,5 @@
+@import 'theme.css'; 
+
+.sphx-glr-multi-img {
+    max-width: 100%;
+}

docs/source/_static/css/custom.css

@@ -23,18 +23,19 @@ which will be used as *parent* class for any of our operators:
 
    from pylops import LinearOperator
 
-This class is a child of the
-:py:class:`scipy.sparse.linalg.LinearOperator` class itself which implements the same methods of its parent class
-as well as an additional method for quick inversion: such method can be easily accessed by using ``\`` between the
-operator and the data (e.g., ``A \ y``).
+This class was originally defined as a child of the :py:class:`scipy.sparse.linalg.LinearOperator`, implementing
+the same methods of its parent class as well as additional methods for quick inversion (e.g., ``A \ y``),
+eigenvalues computation, conversion to dense matrices, etc. From version ``v2.1`` onwards, our linear operator
+class has become stand-alone; however, by keeping the same naming structure of the original scipy class, we still
+allow inter-operability with scipy-native linear operators and solvers.
 
 After that we define our new object:
 
 .. code-block:: python
 
    class Diagonal(LinearOperator):
 
-followed by a `numpydoc docstring <https://numpydoc.readthedocs.io/en/latest/format.html/>`_
+followed by a `numpydoc docstring <https://numpydoc.readthedocs.io/en/latest/format.html>`__
 (starting with ``r"""`` and ending with ``"""``) containing the documentation of the operator. Such docstring should
 contain at least a short description of the operator, a ``Parameters`` section with a detailed description of the
 input parameters and a ``Notes`` section providing a mathematical explanation of the operator. Take a look at
@@ -172,7 +173,7 @@ adheres to the guidelines of PyLops:
 
 - the new class contains at least ``__init__``, ``_matvec`` and ``_matvec`` methods.
 
-- the new class (or function) has a `numpydoc docstring <https://numpydoc.readthedocs.io/>`_ documenting
+- the new class (or function) has a `numpydoc docstring <https://numpydoc.readthedocs.io/>`__ documenting
   at least the input ``Parameters`` and with a ``Notes`` section providing a mathematical explanation of the operator
 
 - a new test has been added to an existing ``test_*.py`` file within the ``pytests`` folder. The test should verify