Replace filters by libdlf (#205)

Old use is still possible until v3.0, but throws a DeprecationWarning for now, and later a FutureWarning.
emsig · Mar 1, 2024 · acddeaa · acddeaa
1 parent 50d8ed5
commit acddeaa
Show file tree

Hide file tree

Showing 28 changed files with 300 additions and 4,724 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -12,6 +12,13 @@ v2.2.x
 latest
 ------
 
+- Filters:
+
+  - The digital linear filters are outsourced to `libdlf
+    <https://github.com/emsig/libdlf>`_. Note: How to access filters changed!
+    The old way still works, with a deprecation note stating how to change your
+    code. The old way will be removed in v3.0.
+
 - Examples:
 
   - @efinden expanded the "Cole-Cole IP" example.
@@ -23,6 +30,7 @@ latest
     - Python 3.9
     - SciPy 1.9
     - Numba 0.53
+    - libdlf (NEW requirement)
 
   - Testing: added Python 3.12, dropped Python 3.8.
 
@@ -31,6 +39,7 @@ latest
   - Many small things to keep the package updated.
 
 
+
 v2.2.2: Flexible dipole coordinates
 -----------------------------------
 

diff --git a/CREDITS.rst b/CREDITS.rst
@@ -59,3 +59,4 @@ certainly incomplete list (get in touch if you think you should appear here):
 - Peter van der Sman
 - `Ralph-Uwe Börner <https://github.com/ruboerner>`_
 - `Leon Foks <https://github.com/leonfoks>`_
+- `Erlend Finden <https://github.com/efinden>`_
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,3 +1,4 @@
+import time
 import warnings
 from empymod import __version__
 from sphinx_gallery.sorting import FileNameSortKey
@@ -90,7 +91,7 @@
 # General information about the project.
 project = 'empymod'
 author = 'The emsig community'
-copyright = f'2016, {author}'
+copyright = f'2016-{time.strftime("%Y")}, {author}'
 
 # |version| and |today| tags (|release|-tag is not used).
 version = __version__

diff --git a/docs/manual/installation.rst b/docs/manual/installation.rst
@@ -13,7 +13,7 @@ or via ``pip``:
 
    pip install empymod
 
-Requirements are the modules ``scipy`` and ``numba``.
+Requirements are the modules ``scipy``, ``numba``, and ``libdlf``.
 
 The modeller empymod comes with add-ons (``empymod.scripts``). These add-ons
 provide some very specific, additional functionalities. Some of these add-ons

diff --git a/docs/manual/references.rst b/docs/manual/references.rst
@@ -90,9 +90,3 @@ References
 .. [ZiSl19] Ziolkowski, A., and E. Slob, 2019, Introduction to
    Controlled-Source Electromagnetic Methods: Cambridge University Press; ISBN:
    `9781107058620 <https://www.cambridge.org/9781107058620>`_.
-
-Software weblinks
-=================
-
-.. [1DCSEM] https://marineemlab.ucsd.edu/Projects/Occam/1DCSEM
-.. [SEG-2012-003] https://software.seg.org/2012/0003
diff --git a/docs/manual/transforms.rst b/docs/manual/transforms.rst
@@ -18,14 +18,15 @@ Included **Fourier transforms**:
 Digital Linear Filters
 ----------------------
 The module :mod:`empymod.filters` comes with many DLFs for the Hankel and the
-Fourier transform. If you want to export one of these filters to plain ASCII
-files you can use the ``tofile``-routine of each filter:
+Fourier transform; since v2.3.0 these are imported from `libdlf`
+<https://github.com/emsig/libdlf>`_. If you want to export one of these filters
+to plain ASCII files you can use the ``tofile``-routine of each filter:
 
 .. code-block:: python
 
     >>> import empymod
     >>> # Load a filter
-    >>> filt = empymod.filters.wer_201_2018()
+    >>> filt = empymod.filters.Hankel().wer_201_2018
     >>> # Save it to pure ASCII-files
     >>> filt.tofile()
     >>> # This will save the following three files: