Watex

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

This release of watex introduces a series of refinements and additions to the API compared to version ``v0.3.2``. The updates
focus on enhancing the user experience through better error handling, performance improvements, and the introduction of new f
unctionalities for geophysical data visualization and analysis.

- |Fix| Addressed an `IndexError` in :meth:`~watex.methods.EM` that was triggered by providing an incorrect path or when EDI
files were missing. The system has been improved to handle such scenarios gracefully, ensuring enhanced error reporting and
overall system robustness.

- |Enhancement| Updated the :meth:`watex.utils.plotutils.plot_errorbar` function by introducing a `show_error_bars` parameter.
This allows for optional suppression of error bars in plots, offering a cleaner visualization option when error bars are
unnecessary or might clutter the display.

- |Enhancement| The newly introduced :meth:`watex.utils.plotutils.plot_tensors2` function replaces the original `plot_tensors`
method, leveraging the `show_error_bars` parameter from `plot_errorbar`. This update facilitates a more tailored approach to the
visualization of electromagnetic tensor data, incorporating feedback from our user community for a more intuitive plotting
experience.

- |Improvement| Enhanced the error handling mechanisms and user feedback for various data loading and processing operations within
watex. These improvements aim to streamline the debugging process, making it easier for both developers and users to diagnose and
resolve issues.

- |Performance| Implemented optimizations in key computational routines and data handling processes. These changes contribute to
faster analysis throughput and more efficient memory usage when working with large geophysical datasets, ensuring that watex can
handle complex analysis tasks with improved performance.

- |Feature| Introduced a new analysis module :func:`watex.utils.plot_tensors2` designed for advanced geophysical interpretation tasks. While still in its early
stages, this module lays the groundwork for sophisticated analytical capabilities that will be expanded in future releases.

- |Documentation| Expanded the documentation to include comprehensive examples and detailed guides for the newly introduced
features. This effort aims to enhance understanding and utilization of watex's capabilities, supporting users in achieving
their analysis objectives with the tool.

These updates reflect our commitment to continually enhancing :code:`watex` based on user input and the evolving needs of the
geophysical analysis community. We value and appreciate the feedback and contributions from our users that drive the ongoing
development and improvement of watex.

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

Minor changes have been made to the API since version ``v0.3.1``, leading
to fixed bugs in frequencies handling.

- |Fix| Fixed the bound error in :meth:`~watex.methods.MT.remove_static_shift` by
rounding the frequency checks to 5 decimal places.

- |Fix| There is no longer a need to recompute frequencies when no extraneous
frequencies are detected for omission. :meth:`~watex.methods.MT.drop_frequencies`
now consistently returns the original :term:`MT` object.

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

Changes and enhancements have been made to the API since version ``v0.3.0``, leading to the introduction of new features and the resolution of various bugs.

- |API change| From now on, only the selected utilities listed below are available as the public API, which has led to shorter loading times for the package. The available
public API functions include:

- :func:`watex.utils.bi_selector` available publicly as :func:`watex.bi_selector`
- :func:`watex.utils.cleaner` available publicly as :func:`watex.cleaner`
- :func:`watex.utils.erpSelector` available publicly as :func:`watex.erpSelector`
- :func:`watex.utils.erpSmartDetector` available publicly as :func:`watex.erpSmartDetector`
- :func:`watex.utils.fetch_data` available publicly as :func:`watex.fetch_data`
- :func:`watex.utils.fittensor` available publicly as :func:`watex.fittensor`
- :func:`watex.utils.get2dtensor` available publicly as :func:`watex.get2dtensor`
- :func:`watex.utils.make_erp` available publicly as :func:`watex.make_erp`
- :func:`watex.utils.make_naive_pipe` available publicly as :func:`watex.make_naive_pipe`
- :func:`watex.utils.make_ves` available publicly as :func:`watex.make_ves`
- :func:`watex.utils.magnitude` available publicly as :func:`watex.magnitude`
- :func:`watex.utils.naive_imputer` available publicly as :func:`watex.naive_imputer`
- :func:`watex.utils.naive_scaler` available publicly as :func:`watex.naive_scaler`
- :func:`watex.utils.ohmicArea` available publicly as :func:`watex.ohmicArea`
- :func:`watex.utils.plotAnomaly` available publicly as :func:`watex.plotAnomaly`
- :func:`watex.utils.plot_confidence_in` available publicly as :func:`watex.plot_confidence_in`
- :func:`watex.utils.plotOhmicArea` available publicly as :func:`watex.plotOhmicArea`
- :func:`watex.utils.plot_sfi` available publicly as :func:`watex.plot_sfi`
- :func:`watex.utils.power` available publicly as :func:`watex.power`
- :func:`watex.utils.qc` available publicly as :func:`watex.qc`
- :func:`watex.utils.read_data` available publicly as :func:`watex.read_data`
- :func:`watex.utils.selectfeatures` available publicly as :func:`watex.selectfeatures`
- :func:`watex.utils.sfi` available publicly as :func:`watex.sfi`
- :func:`watex.utils.shape` available publicly as :func:`watex.shape`
- :func:`watex.utils.smart_label_classifier` available publicly as :func:`watex.smart_label_classifier`
- :func:`watex.utils.to_numeric_dtypes` available publicly as :func:`watex.to_numeric_dtypes`
- :func:`watex.utils.type_` available publicly as :func:`watex.type_`
- :func:`watex.utils.vesSelector` available publicly as :func:`watex.vesSelector`

- |API change| The parameter ``edi_obj`` in :func:`watex.utils.plot_skew` has been deprecated and replaced by ``edis_list``, which refers to either a collection of :term:`EDI` files or a full path to EDI files. Two-dimensional skewness, represented as :math:`eta`, can now be visualized by setting the parameter ``view='2D'``.

- |API change| The ``xgboost`` library is no longer automatically installed as a dependency. Users must install it separately for complete model functionality or use the ``dev`` option as shown below:

.. code-block:: bash

pip install watex[dev]

- |Fix| The :class:`watex.em.EM` module now throws a :class:`watex.exceptions.EDIError` instead of an ``AttributeError`` when an EDI file is expected but an object is passed.

- |Fix| The `base_estimator` parameter is no longer available in scikit-learn versions greater than 1.2; it has been renamed to `estimator`. Consequently, :mod:`watex.models` and :mod:`watex.models.premodels` have been updated to reflect this change.

- |Feature| The :func:`watex.utils.plotutils.plot_l_curve` function has been introduced to plot the Hansen L-curve, with an option to highlight the Hansen point. This feature uses the L-curve criterion to determine the most suitable model after performing multiple inversions with different :math:`\tau` values.

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

These are substantial changes in ``v0.2.7`` API that lead to new features and fugs fixed.

- |API change| Datasets ``h.h5`` and ``n.npz`` for Hongliu hydrogeological logging and Nansha land subsidence data are removed from
the software installation. User can fetch the data as usual and should be downloaded remotely. This will considerably reduce the
size of the :mod:`watex.datasets` package.

- |API change| ``watex.methods.em.Processing`` and ``watex.methods.em.ZC`` do no longer exist.
They have been changed to :class:`watex.methods.em.EMAP` and
:class:`watex.methods.em.MT` respectively.

- |API change| ``watex.utils.funcutils.fit_by_ll`` is deprecated and replaced by :func:`watex.utils.funcutils.fit_ll`.

- |Fix| Bug in removing the static shift in :term:`AMT` data. Henceforth the correction factor method deprecated method ``watex.methods.em.ZC.get_ss_correction_factors``
replaced by :meth:`watex.methods.em.MT.get_ss_correction_factors` is applied for each station differently rather than using
the factor to correct all stations. There are also a choice for user to input the correction factors ``ss_fx`` and ``ss_fy`` manually into a list.

- |Feature| :func:`watex.utils.plotutils.plot_tensors` plots resistivity and phase tensors or the real and imaginary impedance.

- |Feature| :func:`watex.utils.torres_verdin_filter` calculates the adaptive moving average of a given data array from
Torres and Verdin codes.

- |Feature| :func:`watex.methods.em.filter_noises` remove noise from component ``xx``, ``yy``, ``xy`` or ``yx``.

- |Feature| :meth:`watex.methods.em.MT.remove_noises` removes artifacts in the data and smooth it.

- |Feature| :func:`watex.methods.em.drop_frequencies` drop bad frequencies or frequencies with no consistent data in the EDI files.

- |Feature| :func:`watex.utils.plotutils.plot_sounding` plot the vertical electrical resistivity data.

- |Feature| :func:`watex.utils.baseutils.download_file2` is the new consistent function to download file remotely rather than using
:func:`watex.utils.baseutils.get_remote_data`. Both expect ``requests`` library to be installed.

- |Enhancement| :func:`watex.utils.plot_profiling` accepts `ax` as a paramater.

- |Enhancement| :func:`watex.view.TPlot.plot_rhophi` changes the style of plot in preceeding versions. It accepts parameter `kind` for plotting multiple stations differently.

- |Enhancement| Fix overlapping xlabels in the :func:`watex.utils.exmath.plotOhmicArea`.

**Full Changelog**: https://github.com/WEgeophysics/watex/compare/v0.2.6...v0.2.7

**Full Changelog**: https://github.com/WEgeophysics/watex/compare/v0.2.5...v0.2.6