hydrodl2 1.3.0__py3-none-any.whl

hydrodl2/core/calc/utils.py

@@ -0,0 +1,59 @@
+"""
+Note: If adding new public methods, please add them to __all__
+at the top of the file and in calc/__init__.py.
+"""
+
+import torch
+
+
+def change_param_range(param: torch.Tensor, bounds: list[float]) -> torch.Tensor:
+    """Change the range of a parameter to the specified bounds.
+
+    Parameters
+    ----------
+    param
+        The parameter.
+    bounds
+        The parameter bounds.
+
+    Returns
+    -------
+    torch.Tensor
+        The parameter with the specified bounds.
+    """
+    return param * (bounds[1] - bounds[0]) + bounds[0]
+
+
+def param_bounds_2d(
+    params: torch.Tensor,
+    num: int,
+    bounds: list,
+    ndays: int,
+    nmul: int,
+) -> torch.Tensor:
+    """Convert a 2D parameter array to a 3D parameter array.
+
+    Parameters
+    ----------
+    params
+        The 2D parameter array.
+    num
+        The number of parameters.
+    bounds
+        The parameter bounds.
+    ndays
+        The number of days.
+    nmul
+        The number of parallel models.
+
+    Returns
+    -------
+    torch.Tensor
+        The 3D parameter array.
+    """
+    out_temp = (
+        params[:, num * nmul : (num + 1) * nmul] * (bounds[1] - bounds[0]) + bounds[0]
+    )
+    return (
+        out_temp.unsqueeze(0).repeat(ndays, 1, 1).reshape(ndays, params.shape[0], nmul)
+    )

hydrodl2/core/utils/__init__.py

@@ -0,0 +1,7 @@
+from .utils import _get_dir, get_model_dirs, get_model_files
+
+__all__ = [
+    'get_model_dirs',
+    'get_model_files',
+    '_get_dir',
+]

hydrodl2/core/utils/clean_temp.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Recursively remove all cache files (.pyc, __pycache__/) in the working dir.
+# Usage: sh path/to/clean_temp.sh
+
+find . | grep -E "(__pycache__|\.pyc$)" | xargs rm -rf
+find . | grep -E "(.ruff_cache$)" | xargs rm -rf
+find . | grep -E "(.pytest_cache$)" | xargs rm -rf

hydrodl2/core/utils/utils.py

@@ -0,0 +1,63 @@
+"""
+Note: If adding new public methods, please add them to __all__
+at the top of the file and in utils/__init__.py.
+"""
+
+import os
+from pathlib import Path
+from typing import Union
+
+
+def get_model_dirs(directory: Union[Path, str]) -> tuple[list[Path], list[str]]:
+    """Get all subdirectories in a given directory.
+
+    Parameters
+    ----------
+    directory
+        The parent directory.
+    """
+    if isinstance(directory, str):
+        directory = Path(directory)
+
+    dirs = []
+    dir_names = []
+    avoid_list = ['__pycache__']
+
+    for item in directory.iterdir():
+        if item.is_dir() and (item.name not in avoid_list):
+            dirs.append(item)
+            dir_names.append(item.name)
+
+    return dirs, dir_names
+
+
+def get_model_files(directory: Union[Path, str]) -> tuple[list[Path], list[str]]:
+    """Get all files in a given directory.
+
+    Parameters
+    ----------
+    directory
+        The parent directory.
+    """
+    if isinstance(directory, str):
+        directory = Path(directory)
+
+    files = []
+    file_names = []
+    avoid_list = ['__init__', '.DS_Store', 'README.md', '.git']
+
+    for item in directory.iterdir():
+        if item.is_file() and (item.name not in avoid_list):
+            files.append(item)
+
+            # Remove file extension
+            name = os.path.splitext(item.name)[0]
+            file_names.append(name)
+    return files, file_names
+
+
+def _get_dir(dir_name: str) -> Path:
+    """Get the path for the given directory name."""
+    dir = Path(os.path.dirname(os.path.abspath(__file__)))
+    dir = dir.parent.parent / dir_name
+    return dir