Move constructor documentation to class docstrings

UW-Hydro · May 8, 2019 · befe1d2 · befe1d2
1 parent 042d656
commit befe1d2
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 26 deletions.
diff --git a/pysumma/ensemble.py b/pysumma/ensemble.py
@@ -38,6 +38,16 @@ class Ensemble(object):
 
         # open output
         ds = e.merge_output()
+
+    Parameters
+    ----------
+    executable (string):
+        Path to locally compiled SUMMA executable
+        or the name of the docker image to run
+    filemanager (string):
+        Path to the file manager for the desired
+        simulation setup. Can be specified as a
+        relative path
     '''
 
     executable: str = None
@@ -46,19 +56,6 @@ class Ensemble(object):
 
     def __init__(self, executable: str, filemanager: str,
                  configuration: dict, num_workers: int=1):
-        """
-        Initialize a new ensemble object
-
-        Parameters
-        ----------
-        executable (string):
-            Path to locally compiled SUMMA executable
-            or the name of the docker image to run
-        filemanager (string):
-            Path to the file manager for the desired
-            simulation setup. Can be specified as a
-            relative path
-        """
         self._status = 'Initialized'
         self.executable = executable
         self.filemanager = filemanager

diff --git a/pysumma/simulation.py b/pysumma/simulation.py
@@ -35,6 +35,16 @@ class Simulation():
         s.monitor()
         assert s._status == 'Success'
         print(s.output)
+
+    Parameters
+    ----------
+    executable:
+        Path to locally compiled SUMMA executable
+        or the name of the docker image to run
+    filemanager:
+        Path to the file manager for the desired
+        simulation setup. Can be specified as a
+        relative path.
     """
     library_path = None
     process = None
@@ -49,19 +59,6 @@ class Simulation():
     parameter_trial: xr.Dataset = None
 
     def __init__(self, executable, filemanager):
-        """
-        Initialize a new simulation object
-
-        Parameters
-        ----------
-        executable:
-            Path to locally compiled SUMMA executable
-            or the name of the docker image to run
-        filemanager:
-            Path to the file manager for the desired
-            simulation setup. Can be specified as a
-            relative path.
-        """
         self.executable = executable
         self.manager_path = filemanager
         self.manager = FileManager(filemanager)