anemone-core 0.1.0__tar.gz

anemone_core-0.1.0/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 anemone developers
+
+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.

anemone_core-0.1.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: anemone-core
+Version: 0.1.0
+Summary: A PyTorch based 1D electromagnetic modelling and inversion code
+Author-email: Matt Griffiths <mpg@geo.au.dk>
+License: MIT
+Project-URL: Repository, https://github.com/hydrogeophysicsgroup/anemone
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: torch
+Requires-Dist: nosj
+Requires-Dist: biotsavartlaw
+Requires-Dist: libaarhusxyz
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: jupyter>=1.1.1; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-jupyter; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Dynamic: license-file
+
+# anEMone
+a pytorch based 1D electromagnetic modelling and inversion code.
+
+## Installation
+
+```console
+pip install anemone-core
+```
+
+The package is published on PyPI as `anemone-core`, but is imported as `anemone`:
+
+```python
+import anemone
+```
+
+## Documentation
+
+The documentation site is built from markdown files in `docs/` using MkDocs.
+
+Install the documentation tools:
+
+```console
+pip install -e ".[docs]"
+```
+
+Preview the site locally:
+
+```console
+mkdocs serve
+```
+
+Build the static site:
+
+```console
+mkdocs build
+```
+
+Jupyter notebooks can be rendered as documentation pages through `mkdocs-jupyter` when curated notebooks are placed under `docs/` and added to `mkdocs.yml`.

anemone_core-0.1.0/README.md

@@ -0,0 +1,38 @@
+# anEMone
+a pytorch based 1D electromagnetic modelling and inversion code.
+
+## Installation
+
+```console
+pip install anemone-core
+```
+
+The package is published on PyPI as `anemone-core`, but is imported as `anemone`:
+
+```python
+import anemone
+```
+
+## Documentation
+
+The documentation site is built from markdown files in `docs/` using MkDocs.
+
+Install the documentation tools:
+
+```console
+pip install -e ".[docs]"
+```
+
+Preview the site locally:
+
+```console
+mkdocs serve
+```
+
+Build the static site:
+
+```console
+mkdocs build
+```
+
+Jupyter notebooks can be rendered as documentation pages through `mkdocs-jupyter` when curated notebooks are placed under `docs/` and added to `mkdocs.yml`.

anemone_core-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "anemone-core"
+version = "0.1.0"
+description = "A PyTorch based 1D electromagnetic modelling and inversion code"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [
+    { name = "Matt Griffiths", email = "mpg@geo.au.dk" },
+]
+dependencies = [
+    "numpy",
+    "matplotlib",
+    "scipy",
+    "torch",
+    "nosj",
+    "biotsavartlaw",
+    "libaarhusxyz",
+]
+
+[project.urls]
+Repository = "https://github.com/hydrogeophysicsgroup/anemone"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "jupyter>=1.1.1",
+]
+docs = [
+    "mkdocs",
+    "mkdocs-jupyter",
+    "pymdown-extensions",
+    "pytest",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["anemone*"]

anemone_core-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

anemone_core-0.1.0/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+
+setup()

anemone_core-0.1.0/src/anemone/__init__.py

@@ -0,0 +1,26 @@
+import torch
+
+class constants:
+    pi = torch.pi
+    twopi = 2*torch.pi
+    fourpi = 4*torch.pi
+    sqrt_twopi = (2*torch.pi)**(1./2.)
+    sqrt_pi = torch.pi**(1./2.)
+    mu0 = 4*torch.pi*1e-7
+    epsilon0 = 8.854187817e-12
+    log2 = 0.6931471805599453
+
+default_dtype = 'double'
+if default_dtype=='float':
+    torch.set_default_dtype(torch.float32)
+elif default_dtype=='double':
+    torch.set_default_dtype(torch.float64)
+
+def rdtype():
+    return torch.get_default_dtype()
+
+def cdtype():
+    cfloat = rdtype()
+    if   cfloat==torch.float32: return torch.complex64
+    elif cfloat==torch.float64: return torch.complex128
+    raise NotImplementedError(f"no complex type associated with current default float {cfloat}")

anemone_core-0.1.0/src/anemone/experiment/__init__.py

@@ -0,0 +1 @@
+from .experiment import *

anemone_core-0.1.0/src/anemone/experiment/experiment.py

@@ -0,0 +1,53 @@
+import numpy as np
+import torch
+from .. import constants as c
+from ..system import *
+
+
+def compute_relstd(t_gates, data_val, noise_slope_exponent=-0.5, noise_level_at_1ms=1e-8, current=1, relative_noise=0.03):
+    b = noise_level_at_1ms/(1e-3**noise_slope_exponent)
+    abs_noise = b*(t_gates**noise_slope_exponent)
+    y = data_val*current
+    std_rel = abs_noise/y.T
+    relstd_tot = torch.sqrt(std_rel**2 + relative_noise**2)
+    return relstd_tot.to(data_val.device).T
+
+def plot_error_statistics(times, dbdt, dbdt_ref, ax=None, log_relerr=True, abs_color="C0", rel_color="C3", min_percentile=5., max_percentile=95., ok_relerr_lines=3.):
+    if ax is None:
+        from matplotlib.pyplot import subplots
+        fig,ax = subplots()
+
+    abserr = np.abs(dbdt - dbdt_ref)
+    relerr = 100*(dbdt - dbdt_ref) / np.abs(dbdt_ref)
+
+    ax2 = ax.twinx()
+
+    if log_relerr:
+        relerr = np.abs(relerr)
+
+    ax.plot(times, relerr.mean(0), '--', color=rel_color)
+    ax.plot(times, np.median(relerr, axis=0), '-', color=rel_color)
+    lb = np.percentile(relerr, min_percentile, axis=0)
+    ub = np.percentile(relerr, max_percentile, axis=0)
+    ax.fill_between(times, lb, ub, color=rel_color, alpha=0.2)
+
+
+    ax2.loglog(times, abserr.mean(0), '--', color=abs_color)
+    ax2.loglog(times, np.median(abserr, axis=0), '-', color=abs_color)
+    lb = np.percentile(abserr, min_percentile, axis=0)
+    ub = np.percentile(abserr, max_percentile, axis=0)
+    ax2.fill_between(times, lb, ub, color=abs_color, alpha=0.2)
+
+    ax2.set_ylabel('Absolute Error [V/m$^2$]', color=abs_color)
+    ax.set_ylabel('Relative Error [%]', color=rel_color)
+
+    if log_relerr:
+        ax.set_yscale('log')
+
+    ax.grid(lw=0.5, which='both')
+    if ok_relerr_lines is not None:
+        ax.axhline( ok_relerr_lines, color='k', lw=2)
+        ax.axhline(-ok_relerr_lines, color='k', lw=2)
+    ax.set_xlabel('time [s]')
+
+    return ax,ax2

anemone_core-0.1.0/src/anemone/forwards/__init__.py

@@ -0,0 +1 @@
+from .forwards import *