nmag-python-3 0.0.2__py3-none-any.whl

nmesh/utils/timing_memory_utils.py

@@ -0,0 +1,51 @@
+import logging
+import os
+import re
+import time
+
+log = logging.getLogger(__name__)
+
+_time_zero: float | None = None
+
+
+def time_passed() -> float:
+    """Returns elapsed time since the first call to this function."""
+    global _time_zero
+    if _time_zero is None:
+        _time_zero = time.time()
+        return 0.0
+    return time.time() - _time_zero
+
+
+def memstats(self_status_file: str = "/proc/self/status") -> list[float]:
+    """Reads VmSize and VmRSS from /proc/self/status (Linux)."""
+    vmsize_vmrss = [0.0, 0.0]
+    if not os.path.exists(self_status_file):
+        return vmsize_vmrss
+
+    # Matches "VmSize: 1234 kB" or "VmRSS: 5678 KB".
+    re_pattern = re.compile(r"^(VmSize|VmRSS):\s+(\d+)\s+[kK][bB]", re.MULTILINE)
+    try:
+        with open(self_status_file) as fd:
+            content = fd.read()
+            found = 0
+            for match in re_pattern.finditer(content):
+                key = match.group(1)
+                value = float(match.group(2))
+                if key == "VmSize":
+                    vmsize_vmrss[0] = value
+                else:
+                    vmsize_vmrss[1] = value
+                found += 1
+                if found >= 2:
+                    break
+    except Exception as e:
+        log.debug(f"Failed to read memstats: {e}")
+    return vmsize_vmrss
+
+
+def time_vmem_rss() -> tuple[float, float, float]:
+    """Returns (elapsed_time, vmem, rss) where memory is in KB."""
+    t = time_passed()
+    mem = memstats()
+    return t, mem[0], mem[1]

nmesh/utils/types.py

@@ -0,0 +1,13 @@
+"""Common type aliases used throughout the nmesh package."""
+
+from typing import Any, TypeAlias
+
+import numpy as np
+from numpy.typing import NDArray
+
+__all__ = ["ArrayLike", "FloatArray", "BoolArray", "IntArray"]
+
+ArrayLike: TypeAlias = Any
+FloatArray: TypeAlias = NDArray[np.float64]
+BoolArray: TypeAlias = NDArray[np.bool_]
+IntArray: TypeAlias = NDArray[np.int_]

si/constants.py

@@ -0,0 +1,49 @@
+"""
+Original file: https://github.com/nmag-project/nmag-src/blob/master/interface/nsim/si_units/si.py
+Some useful SI constants, defined using the pint library's authoritative values.
+
+This module provides common physical constants as pint Quantity objects
+for direct use in calculations. It replaces hard-coded values with references
+to the pint library's built-in constants, which are based on up-to-date
+CODATA values.
+https://github.com/hgrecco/pint/blob/master/pint/default_en.txt
+https://github.com/hgrecco/pint/blob/master/pint/constants_en.txt
+"""
+
+from si.physical import ureg
+
+# --- Base and Common Units ---
+kilogram = ureg.kilogram
+meter = ureg.meter
+metre = meter  # alternative spelling
+Ampere = ureg.ampere
+Kelvin = ureg.kelvin
+second = ureg.second
+candela = ureg.candela
+mol = ureg.mole
+Joule = ureg.joule
+Newton = ureg.newton
+Tesla = ureg.tesla
+Gauss = ureg.gauss
+
+# --- Physical Constants (from pint's library) ---
+
+mu0 = ureg.mu_0
+Oersted = ureg.oersted
+Oe = Oersted
+bohr_magneton = ureg.bohr_magneton
+positron_charge = ureg.e
+electron_charge = -1 * ureg.e
+boltzmann_constant = ureg.k
+plank_constant = ureg.h
+reduced_plank_constant = ureg.hbar
+
+# --- Custom or Specific Values ---
+
+degrees_per_ns = 1 * ureg.degree / ureg.nanosecond
+
+gamma_e = (ureg.g_e * ureg.e) / (2 * ureg.m_e)
+# This constant, often used in micromagnetics, is the product of the
+# electron gyromagnetic ratio (gamma_e) and the vacuum permeability (mu_0).
+# The negative sign is a convention used in the LLG equation.
+gamma0 = -1 * gamma_e * ureg.mu_0