fullwave25 1.2.2.dev0__py3-none-any.whl → 1.2.3.dev1__py3-none-any.whl

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__)

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

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.dist-info → fullwave25-1.2.3.dev1.dist-info}/METADATA

@@ -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.dist-info → fullwave25-1.2.3.dev1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-fullwave/__init__.py,sha256=sCTjrPFtcpd38ER6lMHSyzBiigVgo-CFpnlSMdJRC3E,1780
+fullwave/__init__.py,sha256=VGy3UMrnjXs3DCBIfhYFDQoGcoQAdR3vyd0mVypwVno,1780
 fullwave/grid.py,sha256=4bLb5_PKmR3KSRcamsT-3feRSACF7-jJKnpCjeoRGDY,7429
 fullwave/medium.py,sha256=NPg3NxLhR6roeroHM32lv-7rk0CALIExHrhSXpHh9MI,48302
 fullwave/sensor.py,sha256=WzLvOpQBBRmQT8nZUw1Xv_-qytjtN9ohkfMTjqMYkuc,6056
@@ -20,29 +20,22 @@ fullwave/medium_builder/presets/domain_water_gel.py,sha256=nFiL0CkmDeJWo7aR2Khn0
 fullwave/medium_builder/presets/data/.keep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fullwave/medium_builder/presets/data/abdominal_wall/i2365f_etfw1.mat,sha256=N3JFFxc9HW1S-NaTPcPlFgXWGIzlrr9X40JbDapTo4g,67348
 fullwave/solver/__init__.py,sha256=E0Jg5akBpicqTjku1puw9rAIoKiw7TwtYNDPiv8G5IY,30
+fullwave/solver/binary_manager.py,sha256=mIT8Lwrh62BGqkwaVhsF3xU21YYy7sbZpZ5CdghqopQ,4696
 fullwave/solver/cuda_utils.py,sha256=iWa_6bicQwSsKGyp47hfAlyGBRZAGfN-sg2frzrQaVU,11352
 fullwave/solver/input_file_writer.py,sha256=MtJXzGsyvPNZqH9PaB2Chi11ocxprm6kk3o9foluaOo,41626
 fullwave/solver/launcher.py,sha256=TOOxupqk_OUxUk24GqozM9VDBl-5KVB6E7t4ojbbTU4,8864
 fullwave/solver/pml_builder.py,sha256=ClMbD1HL-p16hYMAkkG6i23gH2Q04aXZ9aKRiG1UBaA,67445
-fullwave/solver/solver.py,sha256=oDZ0JXD11XvB3pxFa84RDtggtjxYPUISATwuFwtLggo,35462
+fullwave/solver/solver.py,sha256=CrlbrEmdMAKq7TvPq92TpRg7MCqsbYff_Cg8BexJI58,35555
 fullwave/solver/utils.py,sha256=3lota1TDzwAo5kxlrvy30CEnSEyVe4Iqxnh4bpCBHiw,5389
+fullwave/solver/bins/_gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda118,sha256=Ldpn-5DTno02ujPuKhJMAPkbjbVBzrhAH1YZWFExWjg,1179928
+fullwave/solver/bins/_gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda124,sha256=1ztSYqa_JpstPyE7AFvpOh06xS4-aIV2XZF2nuZoIIc,1342432
+fullwave/solver/bins/_gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda129,sha256=-R41oSO5pMsbGs4uuD_nCkgJs-Wvu621cBJhLEhAKes,1644856
+fullwave/solver/bins/_gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda130,sha256=n3zIQThNSsV0pZUeIh9RpQKGoBoyV6UeaVdLCQnxcSg,1410320
+fullwave/solver/bins/_gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda118,sha256=waTmRPVyhK13DCSMXOuIwe_uCMV8WTcp8oboiro9dFs,1233416
+fullwave/solver/bins/_gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda124,sha256=qY64iz4wi62dvrcFsS68ks3qwfpiUaplfVn9r0jqS9o,1404112
+fullwave/solver/bins/_gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda129,sha256=PhGpNRxTGLXbBm55GKxn_uA_lRThENDJNfLtqUlheRM,1755688
+fullwave/solver/bins/_gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda130,sha256=Qjr2mg59dC6xDz2QWbSkf2-DU_uOj7sZbOJ_XaaQ_lo,1480392
 fullwave/solver/bins/database/relaxation_params_database_num_relax=2_20260113_0957.mat,sha256=Fei5ie9wgAAN43pIdSFf6xVaPPDgOaBBZodi3qK6WtQ,168056
-fullwave/solver/bins/exponential_attenuation/gpu/2d/fullwave2_2d_exponential_attenuation_multi_gpu_cuda118,sha256=6rjAflxVI_P1BDu2KXGH9yDnavQE5ugKwA9TJsLYm_s,1134736
-fullwave/solver/bins/exponential_attenuation/gpu/2d/fullwave2_2d_exponential_attenuation_multi_gpu_cuda124,sha256=9RDXKvwvPfykPNuKDUlYpy6wZ9-7oPLlRA0M4rkPSqg,1309560
-fullwave/solver/bins/exponential_attenuation/gpu/2d/fullwave2_2d_exponential_attenuation_multi_gpu_cuda129,sha256=gLqGY5QsUyRo1R3gvx2Pb4ORwME5UoA3iy4lHNM1ok0,1587408
-fullwave/solver/bins/exponential_attenuation/gpu/2d/fullwave2_2d_exponential_attenuation_multi_gpu_cuda130,sha256=p8MQ4S5X9DgZCeQaS2pP_l1JYE8UTo_P2E7pAJ2XLGg,1373064
-fullwave/solver/bins/exponential_attenuation/gpu/3d/fullwave2_3d_exponential_attenuation_multi_gpu_cuda118,sha256=R5JjENS6ekfTDz831BGYvkuvC_c_J7IUko6RvZVrVJ8,1151184
-fullwave/solver/bins/exponential_attenuation/gpu/3d/fullwave2_3d_exponential_attenuation_multi_gpu_cuda124,sha256=ZhmqHz4fgd_1z5_M7_3D0QaFZxypTS-Erzr6y3jY-jI,1321912
-fullwave/solver/bins/exponential_attenuation/gpu/3d/fullwave2_3d_exponential_attenuation_multi_gpu_cuda129,sha256=NZKmatMOs3ZDBV_AsaqoKgz4lzNwyM3ZYYlgPtc-r5c,1624336
-fullwave/solver/bins/exponential_attenuation/gpu/3d/fullwave2_3d_exponential_attenuation_multi_gpu_cuda130,sha256=imUmx4NoPcWd9hMI_yMtx_I9HaiZnIRvO-Z_i9WhTuY,1392776
-fullwave/solver/bins/gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda118,sha256=Ldpn-5DTno02ujPuKhJMAPkbjbVBzrhAH1YZWFExWjg,1179928
-fullwave/solver/bins/gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda124,sha256=1ztSYqa_JpstPyE7AFvpOh06xS4-aIV2XZF2nuZoIIc,1342432
-fullwave/solver/bins/gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda129,sha256=-R41oSO5pMsbGs4uuD_nCkgJs-Wvu621cBJhLEhAKes,1644856
-fullwave/solver/bins/gpu/2d/num_relax=2/fullwave2_2d_2_relax_multi_gpu_cuda130,sha256=n3zIQThNSsV0pZUeIh9RpQKGoBoyV6UeaVdLCQnxcSg,1410320
-fullwave/solver/bins/gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda118,sha256=waTmRPVyhK13DCSMXOuIwe_uCMV8WTcp8oboiro9dFs,1233416
-fullwave/solver/bins/gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda124,sha256=qY64iz4wi62dvrcFsS68ks3qwfpiUaplfVn9r0jqS9o,1404112
-fullwave/solver/bins/gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda129,sha256=PhGpNRxTGLXbBm55GKxn_uA_lRThENDJNfLtqUlheRM,1755688
-fullwave/solver/bins/gpu/3d/num_relax=2/fullwave2_3d_2_relax_multi_gpu_cuda130,sha256=Qjr2mg59dC6xDz2QWbSkf2-DU_uOj7sZbOJ_XaaQ_lo,1480392
 fullwave/utils/__init__.py,sha256=qjVO8bJRJjZL0NrAH2qn55GZi6OXtcmWT-wiJbvjVbk,425
 fullwave/utils/check_functions.py,sha256=ezpwLvTSpriIfguvoWvdiVKjZxMy1m9diP6XZWDIL5E,1484
 fullwave/utils/coordinates.py,sha256=iIfvfrTQ1DA_WG6o2DbCtrjOY3wk076pKOmv7KsLIBs,4358
@@ -53,7 +46,7 @@ fullwave/utils/pulse.py,sha256=aqnCdBxivACouIGlot1aE2k4V9nctUxNCEPzdBpsupg,2811
 fullwave/utils/relaxation_parameters.py,sha256=DEHjr67eHGR-DqEaNsQViokseIsDywtjBjB1DvF4-OM,14106
 fullwave/utils/scatterer.py,sha256=CLqD085f9pqX4cF1YiT2IkzT5P0o1xp45Do7lf5BLnM,24049
 fullwave/utils/signal_process.py,sha256=MP38r37JSPHN4sT-lIReXS5BT2GT_tkRxD0Y1wQ-lNs,5153
-fullwave25-1.2.2.dev0.dist-info/METADATA,sha256=F4HOUeR4Dz91MqWWY05ATXNNpK-yDZ3idlBU4VhBBoc,19027
-fullwave25-1.2.2.dev0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-fullwave25-1.2.2.dev0.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-fullwave25-1.2.2.dev0.dist-info/RECORD,,
+fullwave25-1.2.3.dev1.dist-info/METADATA,sha256=nM0bbLSvmjGIj7eHXAJe39OQ4BOoouGg6WPh0JgXmo8,19027
+fullwave25-1.2.3.dev1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+fullwave25-1.2.3.dev1.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+fullwave25-1.2.3.dev1.dist-info/RECORD,,