blowing-bubbles 0.2.0__tar.gz

blowing_bubbles-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oliver Mohr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

blowing_bubbles-0.2.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: blowing-bubbles
+Version: 0.2.0
+Summary: Equivalent-circuit fitting of electrochemical impedance spectra (EIS).
+Keywords: electrochemistry,impedance spectroscopy,EIS,equivalent circuit,CPE,fitting
+Author: Oliver Mohr
+Author-email: Oliver Mohr <oliver@mohr.dk>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Requires-Dist: matplotlib>=3.4
+Requires-Dist: numpy>=1.20
+Requires-Dist: pandas>=1.3
+Requires-Dist: scipy>=1.7
+Requires-Dist: streamlit>=1.66.1
+Requires-Dist: tool>=0.8.0
+Requires-Python: >=3.13
+Project-URL: Repository, https://github.com/LePies/BlowingBubbles
+Project-URL: Issues, https://github.com/LePies/BlowingBubbles/issues
+Project-URL: Changelog, https://github.com/LePies/BlowingBubbles/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/LePies/BlowingBubbles/tree/main/docs
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="src/blowing_bubbles/ui/assets/icon.svg" width="140" alt="BlowingBubbles icon">
+</p>
+
+# BlowingBubbles
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.14%2B-blue" alt="Python 3.14+">
+  <img src="https://img.shields.io/badge/license-MIT-green" alt="License: MIT">
+  <img src="https://img.shields.io/badge/docs-no_finished_builds-red" alt="Docs: no finished builds">
+</p>
+
+Python tools for electrochemical impedance spectroscopy (EIS): load spectra, evaluate
+the R–CPE equivalent circuit, and fit branch parameters.
+
+## Installation
+
+```bash
+pip install blowing-bubbles
+```
+
+## License
+
+Released under the [MIT License](LICENSE): free use, modification, and redistribution.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup (uv, ruff, ty,
+deptry, pytest). To report a security issue, see [SECURITY.md](SECURITY.md).
+
+## Citation (published scientific work)
+
+If you use BlowingBubbles in **published** scientific work (papers, theses, preprints,
+citable reports), please cite the entry in [`CITATION.bib`](CITATION.bib) or
+[`CITATION.cff`](CITATION.cff). Private or internal use does not require a citation.
+See [`ACADEMIC_CITATION.md`](ACADEMIC_CITATION.md).
+
+## Interactive UI
+
+An optional Streamlit UI (single-spectrum fitting, batch folder fitting, and a
+live-tune mode) is included. Install the extra group and launch it:
+
+```bash
+uv sync --group ui
+streamlit run src/blowing_bubbles/ui/app.py   # or: python -m blowing_bubbles.ui
+```
+
+### Windows desktop app
+
+The same UI can be packaged as a standalone desktop app (native window via
+Edge WebView2, no browser chrome):
+
+```bash
+uv sync --group desktop
+uv run pyinstaller desktop.spec --clean
+# produces dist/BlowingBubbles/ with the launcher BlowingBubbles.exe inside
+# (onedir build: starts much faster than onefile; ship the whole folder)
+```
+
+The exe needs the WebView2 runtime on the target machine (preinstalled on
+Windows 11; a bootstrapper is available for Windows 10).
+
+## Documentation
+
+The documentation is built with [Sphinx](https://www.sphinx-doc.org/). The
+Sphinx dependencies are in the `docs` dependency group, which `uv sync`
+installs by default. From the project root:
+
+```bash
+uv sync
+uv run sphinx-build -W -b html docs/source docs/build/html
+```
+
+Then open `docs/build/html/index.html` in a browser.
+
+The build also runs the scripts in `examples/` to generate the example gallery.
+That takes a few minutes the first time; after that, only changed examples are
+re-run. To re-read all source files, add `-E`; to start completely fresh, delete
+`docs/build/`. See `docs/source/getting_started.rst` for more details.

blowing_bubbles-0.2.0/README.md

@@ -0,0 +1,79 @@
+<p align="center">
+  <img src="src/blowing_bubbles/ui/assets/icon.svg" width="140" alt="BlowingBubbles icon">
+</p>
+
+# BlowingBubbles
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.14%2B-blue" alt="Python 3.14+">
+  <img src="https://img.shields.io/badge/license-MIT-green" alt="License: MIT">
+  <img src="https://img.shields.io/badge/docs-no_finished_builds-red" alt="Docs: no finished builds">
+</p>
+
+Python tools for electrochemical impedance spectroscopy (EIS): load spectra, evaluate
+the R–CPE equivalent circuit, and fit branch parameters.
+
+## Installation
+
+```bash
+pip install blowing-bubbles
+```
+
+## License
+
+Released under the [MIT License](LICENSE): free use, modification, and redistribution.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup (uv, ruff, ty,
+deptry, pytest). To report a security issue, see [SECURITY.md](SECURITY.md).
+
+## Citation (published scientific work)
+
+If you use BlowingBubbles in **published** scientific work (papers, theses, preprints,
+citable reports), please cite the entry in [`CITATION.bib`](CITATION.bib) or
+[`CITATION.cff`](CITATION.cff). Private or internal use does not require a citation.
+See [`ACADEMIC_CITATION.md`](ACADEMIC_CITATION.md).
+
+## Interactive UI
+
+An optional Streamlit UI (single-spectrum fitting, batch folder fitting, and a
+live-tune mode) is included. Install the extra group and launch it:
+
+```bash
+uv sync --group ui
+streamlit run src/blowing_bubbles/ui/app.py   # or: python -m blowing_bubbles.ui
+```
+
+### Windows desktop app
+
+The same UI can be packaged as a standalone desktop app (native window via
+Edge WebView2, no browser chrome):
+
+```bash
+uv sync --group desktop
+uv run pyinstaller desktop.spec --clean
+# produces dist/BlowingBubbles/ with the launcher BlowingBubbles.exe inside
+# (onedir build: starts much faster than onefile; ship the whole folder)
+```
+
+The exe needs the WebView2 runtime on the target machine (preinstalled on
+Windows 11; a bootstrapper is available for Windows 10).
+
+## Documentation
+
+The documentation is built with [Sphinx](https://www.sphinx-doc.org/). The
+Sphinx dependencies are in the `docs` dependency group, which `uv sync`
+installs by default. From the project root:
+
+```bash
+uv sync
+uv run sphinx-build -W -b html docs/source docs/build/html
+```
+
+Then open `docs/build/html/index.html` in a browser.
+
+The build also runs the scripts in `examples/` to generate the example gallery.
+That takes a few minutes the first time; after that, only changed examples are
+re-run. To re-read all source files, add `-E`; to start completely fresh, delete
+`docs/build/`. See `docs/source/getting_started.rst` for more details.

blowing_bubbles-0.2.0/pyproject.toml

@@ -0,0 +1,103 @@
+[project]
+name = "blowing-bubbles"
+version = "0.2.0"
+description = "Equivalent-circuit fitting of electrochemical impedance spectra (EIS)."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.13"
+keywords = [
+    "electrochemistry",
+    "impedance spectroscopy",
+    "EIS",
+    "equivalent circuit",
+    "CPE",
+    "fitting",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Chemistry",
+]
+dependencies = [
+    "matplotlib>=3.4",
+    "numpy>=1.20",
+    "pandas>=1.3",
+    "scipy>=1.7",
+    "streamlit>=1.66.1",
+    "tool>=0.8.0",
+]
+
+[[project.authors]]
+name = "Oliver Mohr"
+email = "oliver@mohr.dk"
+
+[project.urls]
+Repository = "https://github.com/LePies/BlowingBubbles"
+Issues = "https://github.com/LePies/BlowingBubbles/issues"
+Changelog = "https://github.com/LePies/BlowingBubbles/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/LePies/BlowingBubbles/tree/main/docs"
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "deptry>=0.20",
+    "pytest>=9.2.0",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.15.14",
+    "ty>=0.0.38",
+]
+ui = ["streamlit>=1.40"]
+desktop = [
+    "streamlit>=1.40",
+    "pywebview>=5.0",
+    "pyinstaller>=6.0",
+]
+docs = [
+    "furo>=2025.12.19",
+    "myst-nb>=1.4.0",
+    "myst-parser>=5.1.0",
+    "sphinx>=9.0.4",
+    "sphinx-autoapi>=3.8.1",
+    "sphinx-gallery>=0.16",
+    "sphinxcontrib-bibtex>=2.7.0",
+]
+
+[tool.uv]
+default-groups = [
+    "dev",
+    "docs",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["src/tests"]
+
+[tool.coverage.run]
+source = ["blowing_bubbles"]
+omit = [
+    "src/blowing_bubbles/ui/*",
+    "src/tests/*",
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.deptry]
+known_first_party = ["blowing_bubbles"]
+extend_exclude = ["docs/"]
+
+[tool.deptry.package_module_name_map]
+pywebview = "webview"
+
+[tool.deptry.ignore]
+DEP002 = ["tool"]
+DEP004 = ["pytest"]

blowing_bubbles-0.2.0/pyproject.toml.orig

@@ -0,0 +1,93 @@
+[project]
+name = "blowing-bubbles"
+version = "0.2.0"
+description = "Equivalent-circuit fitting of electrochemical impedance spectra (EIS)."
+readme = "README.md"
+authors = [
+    { name = "Oliver Mohr", email = "oliver@mohr.dk" }
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.13"
+keywords = [
+    "electrochemistry",
+    "impedance spectroscopy",
+    "EIS",
+    "equivalent circuit",
+    "CPE",
+    "fitting",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Chemistry",
+]
+dependencies = [
+    "matplotlib>=3.4",
+    "numpy>=1.20",
+    "pandas>=1.3",
+    "scipy>=1.7",
+    "streamlit>=1.66.1",
+    "tool>=0.8.0",
+]
+
+[project.urls]
+Repository = "https://github.com/LePies/BlowingBubbles"
+Issues = "https://github.com/LePies/BlowingBubbles/issues"
+Changelog = "https://github.com/LePies/BlowingBubbles/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/LePies/BlowingBubbles/tree/main/docs"
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "deptry>=0.20",
+    "pytest>=9.2.0",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.15.14",
+    "ty>=0.0.38",
+]
+ui = [
+    "streamlit>=1.40",
+]
+desktop = [
+    "streamlit>=1.40",
+    "pywebview>=5.0",
+    "pyinstaller>=6.0",
+]
+docs = [
+    "furo>=2025.12.19",
+    "myst-nb>=1.4.0",
+    "myst-parser>=5.1.0",
+    "sphinx>=9.0.4",
+    "sphinx-autoapi>=3.8.1",
+    "sphinx-gallery>=0.16",
+    "sphinxcontrib-bibtex>=2.7.0",
+]
+
+[tool.uv]
+default-groups = ["dev", "docs"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["src/tests"]
+
+[tool.coverage.run]
+source = ["blowing_bubbles"]
+omit = ["src/blowing_bubbles/ui/*", "src/tests/*"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.deptry]
+known_first_party = ["blowing_bubbles"]
+extend_exclude = ["docs/"]
+package_module_name_map = { "pywebview" = "webview" }
+ignore = { "DEP002" = ["tool"], "DEP004" = ["pytest"] }

blowing_bubbles-0.2.0/src/blowing_bubbles/__init__.py

@@ -0,0 +1,19 @@
+r"""BlowingBubbles — equivalent-circuit fitting of electrochemical impedance spectra.
+
+The main entry point is :class:`~blowing_bubbles.classes.EISData` (load, process
+and fit a spectrum); fitted parameters are held in
+:class:`~blowing_bubbles.classes.CircuitParameters` and
+:class:`~blowing_bubbles.classes.FitResults`. Subpackages:
+
+- :mod:`blowing_bubbles.classes` — data, parameter and fit-result containers;
+- :mod:`blowing_bubbles.circuit_impedance` — impedance forward model and
+  analytic gradients;
+- :mod:`blowing_bubbles.scripts` — fitting routines and fit-quality metrics.
+
+Licensed under MIT (see ``LICENSE``). Cite ``CITATION.bib`` in published
+scientific work; see ``ACADEMIC_CITATION.md``.
+"""
+
+__version__ = "0.2.0"
+
+__all__ = ["__version__", "circuit_impedance", "classes", "scripts"]

blowing_bubbles-0.2.0/src/blowing_bubbles/circuit_impedance/__init__.py

@@ -0,0 +1,15 @@
+r"""Forward model and gradients for the BlowingBubbles R–CPE equivalent circuit.
+
+Re-exports :func:`~blowing_bubbles.circuit_impedance.impedance.circuit_impedance`
+(complex impedance of the circuit) and
+:func:`~blowing_bubbles.circuit_impedance.impedance.circuit_impedance_parameter_gradient`
+(analytic partial derivatives) from
+:mod:`blowing_bubbles.circuit_impedance.impedance`.
+"""
+
+from .impedance import circuit_impedance, circuit_impedance_parameter_gradient
+
+__all__ = [
+    "circuit_impedance",
+    "circuit_impedance_parameter_gradient",
+]