ladim 2.0.9__py3-none-any.whl → 2.1.6__py3-none-any.whl

ladim/state.py

@@ -1,9 +1,8 @@
 import pandas as pd
 import numpy as np
-from .model import Model, Module
 
 
-class State(Module):
+class State:
     """
     The state module contains static and dynamic particle properties
 
@@ -12,19 +11,24 @@ class State(Module):
     depth of all particles by 1, use state['Z'] += 1
     """
 
+    def __init__(self):
+        self._num_released = 0
+        self._varnames = set()
+        self._data = pd.DataFrame()
+
     @property
     def size(self):
         """
         Current number of particles
         """
-        raise NotImplementedError
+        return len(self._data)
 
     @property
     def released(self):
         """
         Total number of released particles
         """
-        raise NotImplementedError
+        return self._num_released
 
     def append(self, particles: dict):
         """
@@ -34,41 +38,6 @@ class State(Module):
 
         :param particles: A mapping from variable names to values
         """
-        raise NotImplementedError
-
-    def remove(self, particles):
-        """
-        Remove particles
-
-        :param particles: Boolean index of particles to remove
-        :return:
-        """
-        raise NotImplementedError
-
-    def __getitem__(self, item):
-        raise NotImplementedError
-
-    def __setitem__(self, key, value):
-        raise NotImplementedError
-
-    def __len__(self):
-        return self.size
-
-    def __contains__(self, item):
-        raise NotImplementedError
-
-
-class DynamicState(State):
-    def __init__(self):
-        self._num_released = 0
-        self._varnames = set()
-        self._data = pd.DataFrame()
-
-    @property
-    def released(self):
-        return self._num_released
-
-    def append(self, particles: dict):
         # If there are no new particles, do nothing
         if not particles:
             return
@@ -92,22 +61,30 @@ class DynamicState(State):
         self._num_released += num_new_particles
 
     def remove(self, particles):
+        """
+        Remove particles
+
+        :param particles: Boolean index of particles to remove
+        :return:
+        """
         if not np.any(particles):
             return
 
         keep = ~particles
         self._data = self._data.iloc[keep]
 
-    @property
-    def size(self):
-        return len(self._data)
-
     def __getitem__(self, item):
         return self._data[item].values
 
     def __setitem__(self, item, value):
         self._data[item] = value
 
+    def __len__(self):
+        return self.size
+
+    def __contains__(self, item):
+        return item in self._data
+
     def __getattr__(self, item):
         if item not in self:
             raise AttributeError(f'Attribute not defined: {item}')
@@ -124,6 +101,3 @@ class DynamicState(State):
             self._data[item] = value
         else:
             raise AttributeError(f"Attribute not defined: '{item}'")
-
-    def __contains__(self, item):
-        return item in self._data

ladim/tracker.py

@@ -1,21 +1,23 @@
-from .model import Model, Module
 import numpy as np
+import typing
+if typing.TYPE_CHECKING:
+    from .model import Model
 
 
-class Tracker(Module):
-    pass
-
-
-class HorizontalTracker:
+class Tracker:
     """The physical particle tracking kernel"""
+    def __init__(self, integrator, diffusion):
+        self.integrator = integrator
+        self.diffusion = diffusion  # [m2.s-1]
 
-    def __init__(self, method, diffusion) -> None:
+    @staticmethod
+    def from_config(method, diffusion):
         if not diffusion:
             method += "_nodiff"
-        self.integrator = StochasticDifferentialEquationIntegrator.from_keyword(method)
-        self.D = diffusion  # [m2.s-1]
+        integrator = StochasticDifferentialEquationIntegrator.from_keyword(method)
+        return Tracker(integrator, diffusion)
 
-    def update(self, model: Model):
+    def update(self, model: "Model"):
         state = model.state
         grid = model.grid
         forcing = model.forcing
@@ -31,7 +33,7 @@ class HorizontalTracker:
         # Set diffusion function
         def mixing(t, r):
             _ = t
-            stddev = (2 * self.D) ** 0.5
+            stddev = (2 * self.diffusion) ** 0.5
             u_diff = stddev / dx
             return np.broadcast_to(u_diff, r.shape)
 

ladim/utilities.py

@@ -30,3 +30,31 @@ def ingrid(x: float, y: float, subgrid: List[int]) -> bool:
 def read_timedelta(conf) -> np.timedelta64:
     time_value, time_unit = conf
     return np.timedelta64(time_value, time_unit)
+
+
+def load_class(name):
+    import importlib.util
+    import sys
+    from pathlib import Path
+
+    pkg, cls = name.rsplit(sep='.', maxsplit=1)
+
+    # Check if "pkg" is an existing file
+    spec = None
+    module_name = None
+    file_name = pkg + '.py'
+    if Path(file_name).exists():
+        # This can return None if there were import errors
+        module_name = pkg
+        spec = importlib.util.spec_from_file_location(module_name, file_name)
+
+    # If pkg can not be interpreted as a file, use regular import
+    if spec is None:
+        return getattr(importlib.import_module(pkg), cls)
+
+    # File import
+    else:
+        module = importlib.util.module_from_spec(spec)
+        sys.modules[module_name] = module
+        spec.loader.exec_module(module)
+        return getattr(module, cls)

{ladim-2.0.9.dist-info → ladim-2.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ladim
-Version: 2.0.9
+Version: 2.1.6
 Summary: Lagrangian Advection and Diffusion Model
 Home-page: https://github.com/pnsaevik/ladim
 Author: Bjørn Ådlandsvik
@@ -18,6 +18,8 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: netCDF4
+Requires-Dist: numba
+Requires-Dist: numexpr
 Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: pyarrow
@@ -25,6 +27,7 @@ Requires-Dist: pyproj
 Requires-Dist: pyyaml
 Requires-Dist: scipy
 Requires-Dist: xarray
+Dynamic: license-file
 
 LADiM – the Lagrangian Advection and Diffusion Model
 ====================================================

ladim-2.1.6.dist-info/RECORD

@@ -0,0 +1,32 @@
+ladim/__init__.py,sha256=4K0u0bGFAIfFFuiQ5hs1xrHxa8YmuIGeFH2JKcDKM-I,51
+ladim/__main__.py,sha256=I1AOHBQDwQNe3fVmDMyC84JcriqidOEURoeoJSOCTzg,24
+ladim/config.py,sha256=A-yLStNqqDwh_wMCIsmd8cmaXuUvz698IMlYvGZT5tE,5710
+ladim/forcing.py,sha256=DgBi2qEH5etOHTL3fWbPjjUvnLPDU50tknHWdWaNqeI,19061
+ladim/grid.py,sha256=WAfvYYLiiiO8MnMkqCqKSSrVpyooymffqFWTWfF9qLM,20945
+ladim/main.py,sha256=jsrJY7G37oCzQQDXLrlzc_I_jM7a1a-vmmQx9cuLRms,2906
+ladim/model.py,sha256=fJNjCoK4FL45KAEUQUksRgKinehsiZre0RfKYgog-3k,2377
+ladim/output.py,sha256=AlP3_FGKU_bmSLRyiR3cbbNCwMVkYcuwOjoy0397-CI,8307
+ladim/release.py,sha256=P9KnZminvFPMfAJPizo72d6z8-X5ttM9Qw9p_yPtfpQ,13150
+ladim/sample.py,sha256=n8wRGd_VsW_qyQe1ZoTpmfZcdcwB929vsM8PoKG6JTs,8292
+ladim/solver.py,sha256=bfpb2z5ZU0k8eoFWliMMbafYddL7-AfoTvNONO43apo,785
+ladim/state.py,sha256=xDP3DfuG7NZyYOkFr-KUotrbwPIGUVHhqy9Gisl-85Q,2872
+ladim/tracker.py,sha256=Dpf26jAyu1xAuySRsv3-sOCXJhY3sDvmzUiUyMRUYqU,5118
+ladim/utilities.py,sha256=a3ZK3OuJRfzjEDAfASsuEKItyWC-4GsGUWKEZp1hg0E,1790
+ladim/gridforce/ROMS.py,sha256=VzvKXyyYSdQayCszTZQOh36aXyTaCJ7rxOhGDRjbPhE,27796
+ladim/gridforce/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ladim/gridforce/analytical.py,sha256=qI-1LJdjmnwwanzOdrsDZqwGgo73bT75CB7pMaxbHKM,1094
+ladim/gridforce/zROMS.py,sha256=4bnrmcXiWpCAUch9uqd_0XmyKRh-Ll6sFvIHiTbTOOg,23996
+ladim/ibms/__init__.py,sha256=YUbvHnFXfSJ0lTl6elc-ajyIh1LDqWYlX7Q_MHuNce4,939
+ladim/ibms/light.py,sha256=POltHmKkX8-q3t9wXyfcseCKEq9Bq-kX1WEJYsr1lNQ,2737
+ladim/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ladim-2.1.6.dist-info/licenses/LICENSE,sha256=BgtXyjNr6Ly9nQ7ZLXKpV3r5kWRLnh5MiN0dxp0Bvfc,1085
+postladim/__init__.py,sha256=ND-wa5_GNg01Tp0p_1zA1VD804zbfP3o4Cmd8pWU7OE,113
+postladim/cellcount.py,sha256=nCFu9iJmprubn4YmPB4W0VO02GfEb90Iif7D49w1Kss,2054
+postladim/kde_plot.py,sha256=GvMWzT6VxIeXKh1cnqaGzR-4jGG_WIHGMLPpRMXIpo4,1628
+postladim/particlefile.py,sha256=0aif9wYUJ-VrpQKeCef8wB5VCiBB-gWY6sxNCUYviTA,4889
+postladim/variable.py,sha256=-2aihoppYMMmpSpCqaF31XvpinTMaH3Y01-USDIkbBc,6587
+ladim-2.1.6.dist-info/METADATA,sha256=YI0UNYhSahzPv8Za-ekBBFHEMv_yhilg5KAR4i-PVI4,1950
+ladim-2.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ladim-2.1.6.dist-info/entry_points.txt,sha256=JDlNJo87GJaOkH0-BpAzTPLCrZcuPSdSlHNQ4XmnoRg,41
+ladim-2.1.6.dist-info/top_level.txt,sha256=TK8Gl7d6MsrAQvqKG4b6YJCbB4UL46Se3SzsI-sJAuc,16
+ladim-2.1.6.dist-info/RECORD,,

{ladim-2.0.9.dist-info → ladim-2.1.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.2)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ladim-2.0.9.dist-info/RECORD

@@ -1,32 +0,0 @@
-ladim/__init__.py,sha256=yknbApyGLwkuXI_tlmaf1pWerT0JYcqsUX1925PumLM,51
-ladim/__main__.py,sha256=I1AOHBQDwQNe3fVmDMyC84JcriqidOEURoeoJSOCTzg,24
-ladim/config.py,sha256=l20q8C-TPTM8HkVbdYyDCaTD2jszPQPFwnAEdL8i9vs,5769
-ladim/forcing.py,sha256=880ZtuQkkyZsHKD08ogRC__oGAfu-Y_MrHm7uoZoDGU,3153
-ladim/grid.py,sha256=aZl8HUrY5oJSUKoVEY40reOfAEjClHuNlpzNO1GJK8k,20897
-ladim/main.py,sha256=jsrJY7G37oCzQQDXLrlzc_I_jM7a1a-vmmQx9cuLRms,2906
-ladim/model.py,sha256=zTGZtpXFsVlhT8OqaGFMteMc_nsCJEv3ENehhzKuG60,4221
-ladim/output.py,sha256=1d7p2f3fP5flsRaMdGgGAMU3FaQJg-0OASBAF_cN1II,8317
-ladim/release.py,sha256=lYpuwVYXHntW1Q-jFjkVbveGl7SSIb-EfsJfEZutbXs,8339
-ladim/sample.py,sha256=n8wRGd_VsW_qyQe1ZoTpmfZcdcwB929vsM8PoKG6JTs,8292
-ladim/solver.py,sha256=vOfVUzuQnAylPvtgdP6Ez7_pQGbYDCIYgYfXIbJJ-6M,765
-ladim/state.py,sha256=RkKZQn1G9SbhdA3CTq4jpiN-8YIv1QXDRgI6RZlI7U0,3436
-ladim/tracker.py,sha256=hSlCKlBRyLVEYP40QIGKub6mDYFOApyGhUypLrrP9w8,4977
-ladim/utilities.py,sha256=r7-zShqJhh0cBctDUmtfw-GBOk1eTTYR4S72b0ouiSQ,994
-ladim/gridforce/ROMS.py,sha256=yjEf6KM-nxSn4Hexr-5YctQ0rqjzxMDeL4mmQe3w7Vk,27788
-ladim/gridforce/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ladim/gridforce/analytical.py,sha256=qI-1LJdjmnwwanzOdrsDZqwGgo73bT75CB7pMaxbHKM,1094
-ladim/gridforce/zROMS.py,sha256=4bnrmcXiWpCAUch9uqd_0XmyKRh-Ll6sFvIHiTbTOOg,23996
-ladim/ibms/__init__.py,sha256=LLKhHJgEu-W6cbFjzg2apc-MPoY9wJF2z7S9W2EeWA0,698
-ladim/ibms/light.py,sha256=POltHmKkX8-q3t9wXyfcseCKEq9Bq-kX1WEJYsr1lNQ,2737
-ladim/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-postladim/__init__.py,sha256=ND-wa5_GNg01Tp0p_1zA1VD804zbfP3o4Cmd8pWU7OE,113
-postladim/cellcount.py,sha256=nCFu9iJmprubn4YmPB4W0VO02GfEb90Iif7D49w1Kss,2054
-postladim/kde_plot.py,sha256=GvMWzT6VxIeXKh1cnqaGzR-4jGG_WIHGMLPpRMXIpo4,1628
-postladim/particlefile.py,sha256=0aif9wYUJ-VrpQKeCef8wB5VCiBB-gWY6sxNCUYviTA,4889
-postladim/variable.py,sha256=-2aihoppYMMmpSpCqaF31XvpinTMaH3Y01-USDIkbBc,6587
-ladim-2.0.9.dist-info/LICENSE,sha256=BgtXyjNr6Ly9nQ7ZLXKpV3r5kWRLnh5MiN0dxp0Bvfc,1085
-ladim-2.0.9.dist-info/METADATA,sha256=ftaYR5SRvCDWj_8rb7EW-tk_RbpBmjmOGYOg7UP9sVs,1884
-ladim-2.0.9.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-ladim-2.0.9.dist-info/entry_points.txt,sha256=JDlNJo87GJaOkH0-BpAzTPLCrZcuPSdSlHNQ4XmnoRg,41
-ladim-2.0.9.dist-info/top_level.txt,sha256=TK8Gl7d6MsrAQvqKG4b6YJCbB4UL46Se3SzsI-sJAuc,16
-ladim-2.0.9.dist-info/RECORD,,