fullwave25 1.2.2.dev0__tar.gz → 1.2.3.dev1__tar.gz

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "1.2.2-dev0"
+current_version = "1.2.3-dev1"
 parse = """(?x)
     (?P<major>0|[1-9]\\d*)\\.
     (?P<minor>0|[1-9]\\d*)\\.

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fullwave25
-Version: 1.2.2.dev0
+Version: 1.2.3.dev1
 Summary: Fullwave 2.5: Ultrasound wave propagation simulation with heterogeneous power law attenuation modelling capabilities
 Author: Masashi Sode, Gianmarco Pinton
 Maintainer: Masashi Sode

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/fullwave/__init__.py

@@ -60,7 +60,7 @@ try:
     __version__ = version("fullwave")
 except PackageNotFoundError:
     # Update via bump-my-version, not manually
-    __version__ = "1.2.2-dev0"
+    __version__ = "1.2.3-dev1"
 
 VERSION = __version__  # for convenience
 logger.info("Fullwave version: %s", __version__)

fullwave25-1.2.3.dev1/fullwave/solver/binary_manager.py

@@ -0,0 +1,145 @@
+"""Binary manager for fullwave solver executables.
+
+Handles locating, caching, and downloading solver binaries from GitHub releases.
+
+Priority order when resolving a binary:
+1. Bundled binary (shipped with the package or dev install).
+2. Local cache at ``~/.cache/fullwave25/bins/``.
+3. Download from the GitHub release pinned by ``BINARY_RELEASE_TAG``.
+
+Binaries are versioned independently from the Python package — update
+``BINARY_RELEASE_TAG`` only when new binaries are published.
+
+The release tag can be overridden at runtime with the environment variable
+``FULLWAVE25_BINARY_TAG`` (e.g. ``export FULLWAVE25_BINARY_TAG=v1.2.2``).
+"""
+
+import logging
+import os
+import stat
+import urllib.error
+import urllib.request
+from pathlib import Path
+
+logger = logging.getLogger("__main__." + __name__)
+
+GITHUB_REPO = "pinton-lab/fullwave25"
+CACHE_DIR = Path.home() / ".cache" / "fullwave25" / "bins"
+
+# Pinned release tag for the solver binaries.
+# Update this only when new binaries are uploaded to a GitHub release.
+BINARY_RELEASE_TAG = "v1.2.2"
+
+
+def _download_url(filename: str, tag: str) -> str:
+    return f"https://github.com/{GITHUB_REPO}/releases/download/{tag}/{filename}"
+
+
+def _download_binary(url: str, dest: Path) -> None:
+    """Download *url* to *dest*, showing a tqdm progress bar when available."""
+    dest.parent.mkdir(parents=True, exist_ok=True)
+    tmp = dest.with_suffix(".download_tmp")
+    try:
+        try:
+            from tqdm import tqdm
+
+            class _Hook:
+                def __init__(self) -> None:
+                    self._bar: tqdm | None = None
+
+                def __call__(self, block: int, block_size: int, total: int) -> None:  # noqa: ARG002
+                    if self._bar is None:
+                        self._bar = tqdm(
+                            total=total if total > 0 else None,
+                            unit="B",
+                            unit_scale=True,
+                            desc=dest.name,
+                        )
+                    self._bar.update(block_size)
+
+                def close(self) -> None:
+                    if self._bar is not None:
+                        self._bar.close()
+
+            hook = _Hook()
+            try:
+                urllib.request.urlretrieve(url, tmp, reporthook=hook)  # noqa: S310
+            finally:
+                hook.close()
+
+        except ImportError:
+            urllib.request.urlretrieve(url, tmp)  # noqa: S310
+
+        tmp.rename(dest)
+        dest.chmod(dest.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
+        logger.info("Binary saved to %s", dest)
+
+    except Exception:
+        tmp.unlink(missing_ok=True)
+        raise
+
+
+def ensure_binary(local_path: Path) -> Path:
+    """Return an executable path for the solver binary.
+
+    Parameters
+    ----------
+    local_path:
+        The expected bundled path (as computed by ``_retrieve_fullwave_simulation_path``).
+
+    Returns
+    -------
+    Path
+        Resolved path to an executable binary.
+
+    Raises
+    ------
+    RuntimeError
+        If the binary cannot be found locally and the download fails.
+
+    """
+    # 1. Bundled binary present (dev install or package that still ships binaries).
+    if local_path.exists():
+        logger.debug("Using bundled binary: %s", local_path)
+        return local_path
+
+    filename = local_path.name
+    cached = CACHE_DIR / filename
+
+    # 2. Previously downloaded and cached.
+    if cached.exists():
+        logger.debug("Using cached binary: %s", cached)
+        return cached
+
+    # 3. Download from GitHub releases.
+    tag = os.environ.get("FULLWAVE25_BINARY_TAG", BINARY_RELEASE_TAG)
+    url = _download_url(filename, tag)
+
+    logger.info(
+        "Binary '%s' not found locally. Downloading from GitHub release '%s' …",
+        filename,
+        tag,
+    )
+
+    try:
+        _download_binary(url, cached)
+    except urllib.error.HTTPError as e:
+        msg = (
+            f"Could not download binary '{filename}' from:\n  {url}\n"
+            f"HTTP error: {e.code} {e.reason}\n\n"
+            "Possible fixes:\n"
+            f"  • Check that release '{tag}' exists and contains '{filename}'.\n"
+            f"  • Override the tag:  export FULLWAVE25_BINARY_TAG=<tag>\n"
+            f"  • Place the binary manually at:  {cached}\n"
+        )
+        raise RuntimeError(msg) from e
+    except Exception as e:
+        msg = (
+            f"Failed to download binary '{filename}' from:\n  {url}\n"
+            f"Error: {e}\n\n"
+            f"  • Place the binary manually at:  {cached}\n"
+            f"  • Or override the tag:  export FULLWAVE25_BINARY_TAG=<tag>\n"
+        )
+        raise RuntimeError(msg) from e
+
+    return cached

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/fullwave/solver/solver.py

@@ -16,6 +16,7 @@ from fullwave.utils import (
     check_functions,
 )
 
+from .binary_manager import ensure_binary
 from .cuda_utils import get_cuda_architecture, retrieve_cuda_version
 
 logger = logging.getLogger("__main__." + __name__)
@@ -461,13 +462,14 @@ class Solver:
         self.n_relax_mechanisms = medium.n_relaxation_mechanisms
 
         if path_fullwave_simulation_bin is None:
-            path_fullwave_simulation_bin = _retrieve_fullwave_simulation_path(
+            local_path = _retrieve_fullwave_simulation_path(
                 use_gpu=use_gpu,
                 is_3d=self.is_3d,
                 use_exponential_attenuation=self.use_exponential_attenuation,
                 use_isotropic_relaxation=use_isotropic_relaxation,
                 n_relax_mechanisms=self.n_relax_mechanisms,
             )
+            path_fullwave_simulation_bin = ensure_binary(local_path)
         else:
             check_functions.check_path_exists(path_fullwave_simulation_bin)
 

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fullwave25"
-version = "1.2.2-dev0" # Update via bump-my-version, not manually
+version = "1.2.3-dev1" # Update via bump-my-version, not manually
 description = "Fullwave 2.5: Ultrasound wave propagation simulation with heterogeneous power law attenuation modelling capabilities"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -57,4 +57,4 @@ build-backend = "hatchling.build"
 packages = ["fullwave", "fullwave.utils"]
 
 [tool.hatch.build]
-exclude = ["tests", "figs", "examples", ".vscode", ".github"]
+exclude = ["tests", "figs", "examples", ".vscode", ".github", "fullwave/solver/bins/gpu", "fullwave/solver/bins/exponential_attenuation", "fullwave/solver/bins/_exponential_attenuation"]

{fullwave25-1.2.2.dev0 → fullwave25-1.2.3.dev1}/uv.lock

@@ -735,7 +735,7 @@ wheels = [
 
 [[package]]
 name = "fullwave25"
-version = "1.2.2.dev0"
+version = "1.2.3.dev1"
 source = { editable = "." }
 dependencies = [
     { name = "joblib" },