Merge pull request #259 from GeoStat-Framework/custom-generators

Generator: add abstract __init__
GeoStat-Framework · Aug 16, 2022 · 58cc52b · 58cc52b
2 parents 4362175 + 239c3a5
commit 58cc52b
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/src/gstools/field/generator.py b/src/gstools/field/generator.py
@@ -11,7 +11,7 @@
    RandMeth
    IncomprRandMeth
 """
-# pylint: disable=C0103, W0222, C0412
+# pylint: disable=C0103, W0222, C0412, W0231
 import warnings
 from abc import ABC, abstractmethod
 from copy import deepcopy as dcp
@@ -35,7 +35,20 @@
 
 
 class Generator(ABC):
-    """Abstract generator class."""
+    """
+    Abstract generator class.
+
+    Parameters
+    ----------
+    model : :any:`CovModel`
+        Covariance model
+    **kwargs
+        Placeholder for keyword-args
+    """
+
+    @abstractmethod
+    def __init__(self, model, **kwargs):
+        pass
 
     @abstractmethod
     def update(self, model=None, seed=np.nan):