transform.permittivity: add functions for calculations of permittivity. (#117)

* add .vscode to gitignore

* Implement permittivity.

* More permittivity functions.

* Fix realworld test.

* docs

* revert reflection

* Fix reflection test -  height

Author: PeterKraus

.gitignore

@@ -6,4 +6,5 @@ dist/
 *.egg
 build/
 public/
-docs/source/apidoc/
+docs/source/apidoc/
+.vscode/

docs/apidoc_t/module.rst_t

@@ -12,6 +12,8 @@
 {{- "**impedance**: fitting electrochemical impedance spectra" | heading }}
 {% elif 'dgpost.transform.mixtures' == basename %}
 {{- "**mixtures**: converting representations of mixtures" | heading }}
+{% elif 'dgpost.transform.permittivity' == basename %}
+{{- "**permittivity**: calculating complex permittivity" | heading }}
 {% elif 'dgpost.transform.rates' == basename %}
 {{- "**rates**: determining molar rates of chemical species" | heading }}
 {% elif 'dgpost.transform.reflection' == basename %}

docs/source/conf.py

@@ -77,7 +77,7 @@
 sphinx_apidoc_options = autodoc_default_flags
 
 intersphinx_mapping = {
-    "dgbowl_schemas": ("https://dgbowl.github.io/dgbowl-schemas/master", None),
-    "yadg": ("https://dgbowl.github.io/yadg/master", None),
+    "dgbowl_schemas": ("https://dgbowl.github.io/dgbowl-schemas/main", None),
+    "yadg": ("https://dgbowl.github.io/yadg/main", None),
     "matplotlib": ("https://matplotlib.org/stable", None),
 }

docs/source/index.rst

@@ -43,6 +43,7 @@ In addition to the above, dgpost is fully unit- and uncertainty-aware, using the
    apidoc/dgpost.transform.electrochemistry
    apidoc/dgpost.transform.impedance
    apidoc/dgpost.transform.mixtures
+   apidoc/dgpost.transform.permittivity
    apidoc/dgpost.transform.rates
    apidoc/dgpost.transform.reflection
    apidoc/dgpost.transform.table

docs/source/version.rst

@@ -4,6 +4,7 @@
 .. toctree::
    :maxdepth: 1
 
+   version.v2.4
    version.v2.3
    version.v2.2
    version.v2.1

docs/source/version.v2.4.rst

@@ -0,0 +1,23 @@
+**dgpost**-v2.4
+---------------
+
+..
+  .. image:: https://img.shields.io/static/v1?label=dgpost&message=v2.4&color=blue&logo=github
+    :target: https://github.com/dgbowl/dgpost/tree/2.4
+  .. image:: https://img.shields.io/static/v1?label=dgpost&message=v2.4&color=blue&logo=pypi
+    :target: https://pypi.org/project/dgpost/2.4/
+  .. image:: https://img.shields.io/static/v1?label=release%20date&message=2025-06-29&color=red&logo=pypi
+
+.. sectionauthor::
+    Peter Kraus
+
+Developed in the `ConCat lab <https://tu.berlin/en/concat>`_ at Technische Universität Berlin.
+
+An update to ``dgpost-2.3``, including the following changes:
+
+- Added the :mod:`~dgpost.transform.permittivity` module for calculations related to complex permittivity and various corrections.
+- Added a ``prominence`` parameter to pruning functions in :mod:`~dgpost.transform.reflection` module, allowing users a better control of peak picking using peak prominence.
+- Removed the default ``height=0.2`` value used in :func:`~dgpost.transform.reflection.prune_cutoff` and :func:`~dgpost.transform.reflection.prune_gradient` functions
+
+.. codeauthor::
+    Peter Kraus