Add DocStrings

pympipool/interactive/flux.py

@@ -28,11 +28,28 @@ def __init__(
         self._pmi = pmi
         self._future = None
 
-    def bootup(self, command_lst: list[str]):
+    def bootup(
+        self,
+        command_lst: list[str],
+        prefix_name: Optional[str] = None,
+        prefix_path: Optional[str] = None,
+    ):
+        """
+        Boot up the client process to connect to the SocketInterface.
+
+        Args:
+            command_lst (list): list of strings to start the client process
+            prefix_name (str): name of the conda environment to initialize
+            prefix_path (str): path of the conda environment to initialize
+        """
         if self._oversubscribe:
             raise ValueError(
                 "Oversubscribing is currently not supported for the Flux adapter."
             )
+        if prefix_name is not None or prefix_path is not None:
+            raise ValueError(
+                "Conda environments are currently not supported for the Flux adapter."
+            )
         if self._executor is None:
             self._executor = flux.job.FluxExecutor()
         jobspec = flux.job.JobspecV1.from_command(

pympipool/shared/communication.py

@@ -78,6 +78,8 @@ def bootup(
 
         Args:
             command_lst (list): list of strings to start the client process
+            prefix_name (str): name of the conda environment to initialize
+            prefix_path (str): path of the conda environment to initialize
         """
         self._interface.bootup(
             command_lst=command_lst, prefix_name=prefix_name, prefix_path=prefix_path

pympipool/shared/interface.py

@@ -13,7 +13,12 @@ def __init__(self, cwd: str, cores: int = 1, oversubscribe: bool = False):
         self._cores = cores
         self._oversubscribe = oversubscribe
 
-    def bootup(self, command_lst: list[str]):
+    def bootup(
+        self,
+        command_lst: list[str],
+        prefix_name: Optional[str] = None,
+        prefix_path: Optional[str] = None,
+    ):
         raise NotImplementedError
 
     def shutdown(self, wait: bool = True):