epyt-flow 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

epyt_flow/uncertainty/utils.py

@@ -2,6 +2,7 @@
 Module provides some helper functions regarding the implementation of uncertainty.
 """
 import numpy as np
+from numpy.random import Generator
 from scipy.ndimage import gaussian_filter1d
 
 
@@ -54,7 +55,8 @@ def scale_to_range(pattern: np.ndarray, min_value: float, max_value: float) -> n
             + min_value for x in pattern]
 
 
-def generate_random_gaussian_noise(n_samples: int):
+def generate_random_gaussian_noise(n_samples: int, np_rand_gen: Generator = np.random.default_rng()
+                                   ) -> np.ndarray:
     """
     Generates Gaussian noise using a random mean ([0,1]) and random standard deviation ([0,1]).
 
@@ -62,16 +64,23 @@ def generate_random_gaussian_noise(n_samples: int):
     ----------
     n_samples : `int`
         Number of random samples.
+    np_rand_generator : `numpy.random.Generator <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.Generator>`_, optional
+        The random number generator that is going to be used.
+
+        The default is the default BitGenerator (PCG64) as constructed by
+        `numpy.random.default_rng() <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.default_rng>`_.
 
     Returns
     -------
     `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Gaussian noise.
     """
-    return np.random.normal(np.random.rand(), np.random.rand(), size=n_samples)
+    return np_rand_gen.normal(np.random.rand(), np.random.rand(), size=n_samples)
 
 
-def generate_deep_random_gaussian_noise(n_samples: int, mean: float = None):
+def generate_deep_random_gaussian_noise(n_samples: int, mean: float = None,
+                                        np_rand_gen: Generator = np.random.default_rng()
+                                        ) -> np.ndarray:
     """
     Generates random Gaussian noise where the standard deviations (and mean) are changing over time.
 
@@ -84,6 +93,11 @@ def generate_deep_random_gaussian_noise(n_samples: int, mean: float = None):
         If None, random means are generated.
 
         The default is None.
+    np_rand_generator : `numpy.random.Generator <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.Generator>`_, optional
+        The random number generator that is going to be used.
+
+        The default is the default BitGenerator (PCG64) as constructed by
+        `numpy.random.default_rng() <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.default_rng>`_.
 
     Returns
     -------
@@ -93,17 +107,19 @@ def generate_deep_random_gaussian_noise(n_samples: int, mean: float = None):
     noise = []
 
     if mean is None:
-        mean = create_deep_random_pattern(n_samples, min_value=-1., max_value=1.)
+        mean = create_deep_random_pattern(n_samples, min_value=-1., max_value=1.,
+                                          np_rand_gen=np_rand_gen)
     else:
         mean = [mean] * n_samples
-    rand_std = create_deep_random_pattern(n_samples)
-    noise = np.array([np.random.normal(m, s) for m, s in zip(mean, rand_std)])
+    rand_std = create_deep_random_pattern(n_samples, np_rand_gen=np_rand_gen)
+    noise = np.array([np_rand_gen.normal(m, s) for m, s in zip(mean, rand_std)])
 
     return noise
 
 
 def create_deep_random_pattern(n_samples: int, min_value: float = 0., max_value: float = 1.,
-                               init_value: float = None) -> np.ndarray:
+                               init_value: float = None,
+                               np_rand_gen: Generator = np.random.default_rng()) -> np.ndarray:
     """
     Generates a random pattern.
 
@@ -124,6 +140,11 @@ def create_deep_random_pattern(n_samples: int, min_value: float = 0., max_value:
         If None, a random value is used.
 
         The default is None.
+    np_rand_generator : `numpy.random.Generator <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.Generator>`_, optional
+        The random number generator that is going to be used.
+
+        The default is the default BitGenerator (PCG64) as constructed by
+        `numpy.random.default_rng() <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.default_rng>`_.
 
     Returns
     -------
@@ -138,7 +159,7 @@ def create_deep_random_pattern(n_samples: int, min_value: float = 0., max_value:
             start_value = pattern[-1]
 
         pattern += _create_deep_random_pattern(start_value, min_value=min_value,
-                                               max_value=max_value)
+                                               max_value=max_value, np_rand_gen=np_rand_gen)
 
     pattern = pattern[:n_samples]
 
@@ -149,7 +170,8 @@ def create_deep_random_pattern(n_samples: int, min_value: float = 0., max_value:
 
 
 def _create_deep_random_pattern(start_value: float = None, min_length: int = 2, max_length: int = 5,
-                                min_value: float = None, max_value: float = None) -> np.ndarray:
+                                min_value: float = None, max_value: float = None,
+                                np_rand_gen: Generator = np.random.default_rng()) -> np.ndarray:
     """
     Generates a random pattern of random length.
 
@@ -176,6 +198,11 @@ def _create_deep_random_pattern(start_value: float = None, min_length: int = 2,
         Upper bound of the pattern.
 
         The default is one.
+    np_rand_generator : `numpy.random.Generator <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.Generator>`_, optional
+        The random number generator that is going to be used.
+
+        The default is the default BitGenerator (PCG64) as constructed by
+        `numpy.random.default_rng() <https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.default_rng>`_.
 
     Returns
     -------
@@ -186,16 +213,16 @@ def _create_deep_random_pattern(start_value: float = None, min_length: int = 2,
 
     # Random parameters of pattern
     if start_value is None:
-        start_value = np.random.rand()
-    length = np.random.randint(low=min_length, high=max_length)
-    vec = np.random.choice([-.1, .1])
+        start_value = np_rand_gen.random()
+    length = np_rand_gen.integers(low=min_length, high=max_length)
+    vec = np_rand_gen.choice([-.1, .1])
 
     # Generate pattern
     cur_value = start_value
     pattern.append(start_value)
 
     for _ in range(length):
-        cur_value = cur_value + np.random.rand() * vec
+        cur_value = cur_value + np_rand_gen.random() * vec
         pattern.append(cur_value)
         if min_value is not None and max_value is not None:
             if cur_value < min_value:

epyt_flow/utils.py

@@ -314,7 +314,8 @@ def plot_timeseries_prediction(y: np.ndarray, y_pred: np.ndarray,
     return ax
 
 
-def download_if_necessary(download_path: str, url: str, verbose: bool = True) -> None:
+def download_if_necessary(download_path: str, url: str, verbose: bool = True,
+                          backup_urls: list[str] = []) -> None:
     """
     Downloads a file from a given URL if it does not already exist in a given path.
 
@@ -331,6 +332,10 @@ def download_if_necessary(download_path: str, url: str, verbose: bool = True) ->
         If True, a progress bar is shown while downloading the file.
 
         The default is True.
+    backup_urls : `list[str]`, optional
+        List of alternative URLs that are being tried in the case that downloading from 'url' fails.
+
+        The default is an empty list.
     """
     folder_path = str(Path(download_path).parent.absolute())
     create_path_if_not_exist(folder_path)
@@ -338,6 +343,15 @@ def download_if_necessary(download_path: str, url: str, verbose: bool = True) ->
     if not os.path.isfile(download_path):
         response = requests.get(url, stream=verbose, allow_redirects=True, timeout=1000)
 
+        if response.status_code != 200:
+            for backup_url in backup_urls:
+                response = requests.get(backup_url, stream=verbose, allow_redirects=True,
+                                        timeout=1000)
+                if response.status_code == 200:
+                    break
+        if response.status_code != 200:
+            raise SystemError(f"Failed to download -- {response.status_code}")
+
         if verbose is True:
             content_length = int(response.headers.get('content-length', 0))
             with open(download_path, "wb") as file, tqdm(desc=download_path,

epyt_flow/visualization/__init__.py

@@ -0,0 +1,2 @@
+from .visualization_utils import *
+from .scenario_visualizer import *