Empymod

------------------------------------------------

**2018-11-20**

- Many little improvements in the documentation.
- Some code improvements through the use of codacy.
- Remove testing of Python 3.4; officially supported are now Python 3.5-3.7.
- Version of the `filter article <https://github.com/emsig/article-fdesign>`_
(DLF) in geophysics and of the `CSEM book
<https://github.com/emsig/csem-ziolkowski-and-slob>`_.

------------------------------------------

**2018-10-26**

- ``model.bipole``, ``model.dipole``, and ``model.analytical`` have now a hook
which users can exploit to insert their own calculation of ``etaH``,
``etaV``, ``zetaH``, and ``zetaV``. This can be used, for instance, to model
a Cole-Cole IP survey. See the manual or the example-notebooks for more
information.

- ``model.wavenumber`` renamed to ``model.dipole_k`` to avoid name clash with
``kernel.wavenumber``. For now ``model.wavenumber`` continues to exist, but
raises a deprecation warning.

- ``xdirect`` default value changed from ``True`` to ``False``.

- Possibility to provide interpolated points (``int_pts``) to
``transform.dlf``.

The following changes are backwards incompatible if you directly used
``transform.fht``, ``transform.hqwe``, or ``transform.hquad``. Nothing changes
for the user-facing routines in ``model``:

- ``empymod.fem`` now passes ``factAng`` to ``empymod.transform``, not
``angle``; this saves some time if looped over offsets or frequencies, as it
is not repeatedly calculated within ``empymod.transform``.

- Use ``get_spline_values`` in ``empymod.fem`` for Hankel DLF, instead of in
``empymod.fht``. Gives a speed-up if looped over offsets or frequencies.
Should be in ``utils``, but that would be heavily backwards incompatible.
Move there in version 2.0.


v1.7.x
""""""

------------------------------------------------

**2018-07-16**

- Small improvements related to speed as a result of the benchmarks introduced
in v1.7.2:

- Kernels which do not exist for a given ``ab`` are now returned as ``None``
from ``kernel.wavenumber`` instead of arrays of zeroes. This permits for
some time saving in the transforms. This change is backwards incompatible
if you directly used ``kernel.wavenumber``. Nothing changes for the
user-facing routines in ``model``.

- Adjustments in ``transform`` with regard to the ``None`` returned by
``kernel.wavenumber``. The kernels are not checked anymore if they are all
zeroes (which can be slow for big arrays). If they are not None, they will
be processed.

- Various small improvements for speed to ``transform.dlf`` (i.e.
``factAng``; ``log10``/``log``; re-arranging).

-----------------------------

**2018-07-07**

- Benchmarks: ``empymod`` has now a benchmark suite, see `emsig/empymod-asv
<https://github.com/emsig/empymod-asv>`_.

- Fixed a bug in ``bipole`` for time-domain responses with several receivers or
sources with different depths. (Simply failed, as wrong dimension was
provided to ``tem``).

- Small improvements:

- Various simplifications or cleaning of the code base.
- Small change (for speed) in check if kernels are empty in ``transform.dlf``
and ``transform.qwe``.

----------------------------------------

**2018-06-19**

- New routines in ``empymod.filters.DigitalFilter``: Filters can now be saved
to or loaded from pure ascii-files.

- Filters and inversion result from ``empymod.scripts.fdesign`` are now by
default saved in plain text. The filters with their internal routine, the
inversion result with ``np.savetxt``. Compressed saving can be achieved by
giving a name with a '.gz'-ending.

- Change in ``empymod.utils``:

- Renamed ``_min_param`` to ``_min_res``.
- Anisotropy ``aniso`` is no longer directly checked for its minimum value.
Instead, res*aniso**2, hence vertical resistivity, is checked with
``_min_res``, and anisotropy is subsequently re-calculated from it.
- The parameters ``epermH``, ``epermV``, ``mpermH``, and ``mpermV`` can now
be set to 0 (or any positive value) and do not depend on ``_min_param``.

- ``printinfo``: Generally improved; prints now MKL-info (if available)
independently of ``numexpr``.

- Simplification of ``kernel.reflections`` through re-arranging.

- Bug fixes

- Version of re-submission of the DLF article to geophysics.

----------------------------------------------

**2018-05-23**

Merge ``empyscripts`` into ``empymod`` under ``empymod.scripts``.

- Clear separation between mandatory and optional imports:

- Mandatory:

- ``numpy``
- ``scipy``

- Optional:

- ``numexpr`` (for ``empymod.kernel``)
- ``matplotlib`` (for ``empymod.scripts.fdesign``)
- ``IPython`` (for ``empymod.scripts.printinfo``)

- Broaden namespace of ``empymod``. All public functions from the various
modules and the modules from ``empymod.scripts`` are now available under
``empymod`` directly.


v1.6.x
""""""