sim-tools 1.1.0__tar.gz → 1.2.0__tar.gz

{sim_tools-1.1.0 → sim_tools-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sim-tools
-Version: 1.1.0
+Version: 1.2.0
 Summary: Simulation Tools for Education and Practice
 Project-URL: Homepage, https://github.com/sim-tools/sim-tools
 Project-URL: Bug Tracker, https://github.com/sim-tools/sim-tools/issues

{sim_tools-1.1.0 → sim_tools-1.2.0}/sim_tools/__init__.py

@@ -1,5 +1,5 @@
 """sim-tools"""
 
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 
 from . import datasets, distributions, time_dependent, ovs, output_analysis

{sim_tools-1.1.0 → sim_tools-1.2.0}/sim_tools/distributions.py

@@ -601,7 +601,12 @@ class DistributionRegistry:
 
         # Copy params and inject the random seed.
         params = dist_config["params"].copy()
-        params["random_seed"] = seed
+
+        # Only inject random seed if class constructor accepts it
+        distribution_class = cls.get(dist_config["class_name"])
+        sig = inspect.signature(distribution_class.__init__)
+        if "random_seed" in sig.parameters:
+            params["random_seed"] = seed
 
         # Instantiate and return the distribution object.
         return cls.create(dist_config["class_name"], **params)
@@ -1230,18 +1235,32 @@ class CombinationDistribution:
     sample a combination of values from multiple distributions.
     """
 
-    def __init__(self, *dists: Distribution):
+    def __init__(self, *args: Distribution, dists=None):
         """
-        Initialize a combination distribution.
+        Initialise a combination distribution.
+
+        Distributions can be passed either as positional arguments or via the
+        `dists` keyword argument, but not both. The keyword form is required
+        when creating instances through the `DistributionRegistry` class,
+        which passes parameters by name.
 
         Parameters
         ----------
-        *dists : Sequence[Distribution]
-            Variable length sequence of Distribution objects to combine.
-            The sample method will return the sum of samples from all these
-            distributions.
-        """
-        self.dists = dists
+        *args : Distribution
+            Distribution objects to combine, passed as positional arguments.
+            E.g. `CombinationDistribution(d1, d2)`.
+            Cannot be used together with `dists`.
+        dists : Sequence[Distribution], optional
+            Distribution objects to combine, passed as a keyword argument.
+            E.g. `CombinationDistribution(dists=[d1, d2])`.
+            Cannot be used together with `*args`.
+        """
+        if args and dists is not None:
+            raise ValueError(
+                "Pass distributions either as positional arguments or as "
+                "'dists', not both."
+            )
+        self.dists = dists if dists is not None else args
 
     def __repr__(self):
         dist_reprs = [repr(dist) for dist in self.dists]
@@ -2345,7 +2364,7 @@ class DiscreteEmpirical:
         """
 
         # convert to array first
-        self.values = np.asarray(values)
+        self.values = np.asarray(list(values))
         self.freq = np.asarray(freq)
 
         validate(self.freq, "freq", is_positive_array)
@@ -2394,7 +2413,6 @@ class DiscreteEmpirical:
             - A numpy array of values with shape determined by size parameter
         """
         sample = self.rng.choice(self.values, p=self.probabilities, size=size)
-
         if size is None:
             return sample.item()
         return sample

{sim_tools-1.1.0 → sim_tools-1.2.0}/sim_tools/time_dependent.py

@@ -10,7 +10,11 @@ import pandas as pd
 import matplotlib.pyplot as plt
 import itertools
 
+from sim_tools.distributions import DistributionRegistry
+
+
 # pylint: disable=too-few-public-methods
+@DistributionRegistry.register()
 class NSPPThinning:
     """
     Non Stationary Poisson Process via Thinning.