executorlib 1.2.1__tar.gz → 1.4.0__tar.gz

{executorlib-1.2.1 → executorlib-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: executorlib
-Version: 1.2.1
+Version: 1.4.0
 Summary: Up-scale python functions for high performance computing (HPC) with executorlib.
 Project-URL: Homepage, https://github.com/pyiron/executorlib
 Project-URL: Documentation, https://executorlib.readthedocs.io
@@ -56,12 +56,12 @@ Requires-Dist: ipython<=9.0.2,>=7.33.0; extra == 'all'
 Requires-Dist: mpi4py<=4.0.1,>=3.1.4; extra == 'all'
 Requires-Dist: networkx<=3.4.2,>=2.8.8; extra == 'all'
 Requires-Dist: pygraphviz<=1.14,>=1.10; extra == 'all'
-Requires-Dist: pysqa==0.2.4; extra == 'all'
+Requires-Dist: pysqa==0.2.5; extra == 'all'
 Provides-Extra: cache
 Requires-Dist: h5py<=3.13.0,>=3.6.0; extra == 'cache'
 Provides-Extra: cluster
 Requires-Dist: h5py<=3.13.0,>=3.6.0; extra == 'cluster'
-Requires-Dist: pysqa==0.2.4; extra == 'cluster'
+Requires-Dist: pysqa==0.2.5; extra == 'cluster'
 Provides-Extra: graph
 Requires-Dist: networkx<=3.4.2,>=2.8.8; extra == 'graph'
 Requires-Dist: pygraphviz<=1.14,>=1.10; extra == 'graph'

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/__init__.py

@@ -1,3 +1,4 @@
+from executorlib.executor.base import BaseExecutor
 from executorlib.executor.flux import (
     FluxClusterExecutor,
     FluxJobExecutor,
@@ -13,6 +14,7 @@ from . import _version
 
 __all__: list[str] = [
     "get_cache_data",
+    "BaseExecutor",
     "FluxJobExecutor",
     "FluxClusterExecutor",
     "SingleNodeExecutor",

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2.1'
-__version_tuple__ = version_tuple = (1, 2, 1)
+__version__ = version = '1.4.0'
+__version_tuple__ = version_tuple = (1, 4, 0)

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/executor/base.py

@@ -1,4 +1,5 @@
 import queue
+from abc import ABC
 from concurrent.futures import (
     Executor as FutureExecutor,
 )
@@ -10,7 +11,7 @@ from typing import Callable, Optional
 from executorlib.task_scheduler.base import TaskSchedulerBase
 
 
-class ExecutorBase(FutureExecutor):
+class BaseExecutor(FutureExecutor, ABC):
     """
     Interface class for the executor.
 
@@ -111,6 +112,15 @@ class ExecutorBase(FutureExecutor):
         """
         return len(self._task_scheduler)
 
+    def __bool__(self):
+        """
+        Overwrite length to always return True
+
+        Returns:
+            bool: Always return True
+        """
+        return True
+
     def __exit__(self, *args, **kwargs) -> None:
         """
         Exit method called when exiting the context manager.

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/executor/flux.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_command_line_argument_lst,
     check_init_function,
@@ -17,13 +17,13 @@ from executorlib.task_scheduler.interactive.dependency import DependencyTaskSche
 from executorlib.task_scheduler.interactive.onetoone import OneProcessTaskScheduler
 
 
-class FluxJobExecutor(ExecutorBase):
+class FluxJobExecutor(BaseExecutor):
     """
-    The executorlib.Executor leverages either the message passing interface (MPI), the SLURM workload manager or
+    The executorlib.FluxJobExecutor leverages either the message passing interface (MPI), the SLURM workload manager or
     preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
-    the mpi4py.futures.MPIPoolExecutor the executorlib.Executor can be executed in a serial python process and does not
-    require the python script to be executed with MPI. It is even possible to execute the executorlib.Executor directly
-    in an interactive Jupyter notebook.
+    the mpi4py.futures.MPIPoolExecutor the executorlib.FluxJobExecutor can be executed in a serial python process and
+    does not require the python script to be executed with MPI. It is even possible to execute the
+    executorlib.FluxJobExecutor directly in an interactive Jupyter notebook.
 
     Args:
         max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
@@ -65,7 +65,7 @@ class FluxJobExecutor(ExecutorBase):
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.executor.flux import FluxJobExecutor
+        >>> from executorlib import FluxJobExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -102,12 +102,11 @@ class FluxJobExecutor(ExecutorBase):
         plot_dependency_graph_filename: Optional[str] = None,
     ):
         """
-        Instead of returning a executorlib.Executor object this function returns either a executorlib.mpi.PyMPIExecutor,
-        executorlib.slurm.PySlurmExecutor or executorlib.flux.PyFluxExecutor depending on which backend is available. The
-        executorlib.flux.PyFluxExecutor is the preferred choice while the executorlib.mpi.PyMPIExecutor is primarily used
-        for development and testing. The executorlib.flux.PyFluxExecutor requires flux-core from the flux-framework to be
-        installed and in addition flux-sched to enable GPU scheduling. Finally, the executorlib.slurm.PySlurmExecutor
-        requires the SLURM workload manager to be installed on the system.
+        The executorlib.FluxJobExecutor leverages either the message passing interface (MPI), the SLURM workload manager
+         or preferable the flux framework for distributing python functions within a given resource allocation. In
+         contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.FluxJobExecutor can be executed in a serial
+         python process and does not require the python script to be executed with MPI. It is even possible to execute
+         the executorlib.FluxJobExecutor directly in an interactive Jupyter notebook.
 
         Args:
             max_workers (int): for backwards compatibility with the standard library, max_workers also defines the
@@ -202,13 +201,13 @@ class FluxJobExecutor(ExecutorBase):
             )
 
 
-class FluxClusterExecutor(ExecutorBase):
+class FluxClusterExecutor(BaseExecutor):
     """
-    The executorlib.Executor leverages either the message passing interface (MPI), the SLURM workload manager or
-    preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
-    the mpi4py.futures.MPIPoolExecutor the executorlib.Executor can be executed in a serial python process and does not
-    require the python script to be executed with MPI. It is even possible to execute the executorlib.Executor directly
-    in an interactive Jupyter notebook.
+    The executorlib.FluxClusterExecutor leverages either the message passing interface (MPI), the SLURM workload manager
+    or preferable the flux framework for distributing python functions within a given resource allocation. In contrast
+    to the mpi4py.futures.MPIPoolExecutor the executorlib.FluxClusterExecutor can be executed in a serial python process
+    and does not require the python script to be executed with MPI. It is even possible to execute the
+    executorlib.FluxClusterExecutor directly in an interactive Jupyter notebook.
 
     Args:
         max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
@@ -246,7 +245,7 @@ class FluxClusterExecutor(ExecutorBase):
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.executor.flux import FluxClusterExecutor
+        >>> from executorlib import FluxClusterExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -280,12 +279,11 @@ class FluxClusterExecutor(ExecutorBase):
         plot_dependency_graph_filename: Optional[str] = None,
     ):
         """
-        Instead of returning a executorlib.Executor object this function returns either a executorlib.mpi.PyMPIExecutor,
-        executorlib.slurm.PySlurmExecutor or executorlib.flux.PyFluxExecutor depending on which backend is available. The
-        executorlib.flux.PyFluxExecutor is the preferred choice while the executorlib.mpi.PyMPIExecutor is primarily used
-        for development and testing. The executorlib.flux.PyFluxExecutor requires flux-core from the flux-framework to be
-        installed and in addition flux-sched to enable GPU scheduling. Finally, the executorlib.slurm.PySlurmExecutor
-        requires the SLURM workload manager to be installed on the system.
+        The executorlib.FluxClusterExecutor leverages either the message passing interface (MPI), the SLURM workload
+        manager or preferable the flux framework for distributing python functions within a given resource allocation.
+        In contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.FluxClusterExecutor can be executed in a
+        serial python process and does not require the python script to be executed with MPI. It is even possible to
+        execute the executorlib.FluxClusterExecutor directly in an interactive Jupyter notebook.
 
         Args:
             max_workers (int): for backwards compatibility with the standard library, max_workers also defines the

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/executor/single.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_command_line_argument_lst,
     check_gpus_per_worker,
@@ -17,13 +17,13 @@ from executorlib.task_scheduler.interactive.dependency import DependencyTaskSche
 from executorlib.task_scheduler.interactive.onetoone import OneProcessTaskScheduler
 
 
-class SingleNodeExecutor(ExecutorBase):
+class SingleNodeExecutor(BaseExecutor):
     """
-    The executorlib.Executor leverages either the message passing interface (MPI), the SLURM workload manager or
-    preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
-    the mpi4py.futures.MPIPoolExecutor the executorlib.Executor can be executed in a serial python process and does not
-    require the python script to be executed with MPI. It is even possible to execute the executorlib.Executor directly
-    in an interactive Jupyter notebook.
+    The executorlib.SingleNodeExecutor leverages either the message passing interface (MPI), the SLURM workload manager
+    or preferable the flux framework for distributing python functions within a given resource allocation. In contrast
+    to the mpi4py.futures.MPIPoolExecutor the executorlib.SingleNodeExecutor can be executed in a serial python process
+    and does not require the python script to be executed with MPI. It is even possible to execute the
+    executorlib.SingleNodeExecutor directly in an interactive Jupyter notebook.
 
     Args:
         max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
@@ -60,7 +60,7 @@ class SingleNodeExecutor(ExecutorBase):
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.executor.single import SingleNodeExecutor
+        >>> from executorlib import SingleNodeExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -93,12 +93,11 @@ class SingleNodeExecutor(ExecutorBase):
         plot_dependency_graph_filename: Optional[str] = None,
     ):
         """
-        Instead of returning a executorlib.Executor object this function returns either a executorlib.mpi.PyMPIExecutor,
-        executorlib.slurm.PySlurmExecutor or executorlib.flux.PyFluxExecutor depending on which backend is available. The
-        executorlib.flux.PyFluxExecutor is the preferred choice while the executorlib.mpi.PyMPIExecutor is primarily used
-        for development and testing. The executorlib.flux.PyFluxExecutor requires flux-core from the flux-framework to be
-        installed and in addition flux-sched to enable GPU scheduling. Finally, the executorlib.slurm.PySlurmExecutor
-        requires the SLURM workload manager to be installed on the system.
+        The executorlib.SingleNodeExecutor leverages either the message passing interface (MPI), the SLURM workload
+        manager or preferable the flux framework for distributing python functions within a given resource allocation.
+        In contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.SingleNodeExecutor can be executed in a serial
+        python process and does not require the python script to be executed with MPI. It is even possible to execute
+        the executorlib.SingleNodeExecutor directly in an interactive Jupyter notebook.
 
         Args:
             max_workers (int): for backwards compatibility with the standard library, max_workers also defines the

{executorlib-1.2.1 → executorlib-1.4.0}/executorlib/executor/slurm.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_init_function,
     check_plot_dependency_graph,
@@ -18,13 +18,13 @@ from executorlib.task_scheduler.interactive.slurmspawner import (
 )
 
 
-class SlurmClusterExecutor(ExecutorBase):
+class SlurmClusterExecutor(BaseExecutor):
     """
-    The executorlib.Executor leverages either the message passing interface (MPI), the SLURM workload manager or
-    preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
-    the mpi4py.futures.MPIPoolExecutor the executorlib.Executor can be executed in a serial python process and does not
-    require the python script to be executed with MPI. It is even possible to execute the executorlib.Executor directly
-    in an interactive Jupyter notebook.
+    The executorlib.SlurmClusterExecutor leverages either the message passing interface (MPI), the SLURM workload
+    manager or preferable the flux framework for distributing python functions within a given resource allocation. In
+    contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.SlurmClusterExecutor can be executed in a serial
+    python process and does not require the python script to be executed with MPI. It is even possible to execute the
+    executorlib.SlurmClusterExecutor directly in an interactive Jupyter notebook.
 
     Args:
         max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
@@ -62,7 +62,7 @@ class SlurmClusterExecutor(ExecutorBase):
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.executor.slurm import SlurmClusterExecutor
+        >>> from executorlib import SlurmClusterExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -96,12 +96,11 @@ class SlurmClusterExecutor(ExecutorBase):
         plot_dependency_graph_filename: Optional[str] = None,
     ):
         """
-        Instead of returning a executorlib.Executor object this function returns either a executorlib.mpi.PyMPIExecutor,
-        executorlib.slurm.PySlurmExecutor or executorlib.flux.PyFluxExecutor depending on which backend is available. The
-        executorlib.flux.PyFluxExecutor is the preferred choice while the executorlib.mpi.PyMPIExecutor is primarily used
-        for development and testing. The executorlib.flux.PyFluxExecutor requires flux-core from the flux-framework to be
-        installed and in addition flux-sched to enable GPU scheduling. Finally, the executorlib.slurm.PySlurmExecutor
-        requires the SLURM workload manager to be installed on the system.
+        The executorlib.SlurmClusterExecutor leverages either the message passing interface (MPI), the SLURM workload
+        manager or preferable the flux framework for distributing python functions within a given resource allocation.
+        In contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.SlurmClusterExecutor can be executed in a
+        serial python process and does not require the python script to be executed with MPI. It is even possible to
+        execute the executorlib.SlurmClusterExecutor directly in an interactive Jupyter notebook.
 
         Args:
             max_workers (int): for backwards compatibility with the standard library, max_workers also defines the
@@ -194,13 +193,13 @@ class SlurmClusterExecutor(ExecutorBase):
             )
 
 
-class SlurmJobExecutor(ExecutorBase):
+class SlurmJobExecutor(BaseExecutor):
     """
-    The executorlib.Executor leverages either the message passing interface (MPI), the SLURM workload manager or
+    The executorlib.SlurmJobExecutor leverages either the message passing interface (MPI), the SLURM workload manager or
     preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
-    the mpi4py.futures.MPIPoolExecutor the executorlib.Executor can be executed in a serial python process and does not
-    require the python script to be executed with MPI. It is even possible to execute the executorlib.Executor directly
-    in an interactive Jupyter notebook.
+    the mpi4py.futures.MPIPoolExecutor the executorlib.SlurmJobExecutor can be executed in a serial python process and
+    does not require the python script to be executed with MPI. It is even possible to execute the
+    executorlib.SlurmJobExecutor directly in an interactive Jupyter notebook.
 
     Args:
         max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
@@ -241,7 +240,7 @@ class SlurmJobExecutor(ExecutorBase):
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.executor.slurm import SlurmJobExecutor
+        >>> from executorlib import SlurmJobExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -274,12 +273,11 @@ class SlurmJobExecutor(ExecutorBase):
         plot_dependency_graph_filename: Optional[str] = None,
     ):
         """
-        Instead of returning a executorlib.Executor object this function returns either a executorlib.mpi.PyMPIExecutor,
-        executorlib.slurm.PySlurmExecutor or executorlib.flux.PyFluxExecutor depending on which backend is available. The
-        executorlib.flux.PyFluxExecutor is the preferred choice while the executorlib.mpi.PyMPIExecutor is primarily used
-        for development and testing. The executorlib.flux.PyFluxExecutor requires flux-core from the flux-framework to be
-        installed and in addition flux-sched to enable GPU scheduling. Finally, the executorlib.slurm.PySlurmExecutor
-        requires the SLURM workload manager to be installed on the system.
+        The executorlib.SlurmJobExecutor leverages either the message passing interface (MPI), the SLURM workload
+        manager or preferable the flux framework for distributing python functions within a given resource allocation.
+        In contrast to the mpi4py.futures.MPIPoolExecutor the executorlib.SlurmJobExecutor can be executed in a serial
+        python process and does not require the python script to be executed with MPI. It is even possible to execute
+        the executorlib.SlurmJobExecutor directly in an interactive Jupyter notebook.
 
         Args:
             max_workers (int): for backwards compatibility with the standard library, max_workers also defines the

{executorlib-1.2.1 → executorlib-1.4.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "hatchling==1.27.0",
-    "hatch-vcs==0.4.0",
+    "hatch-vcs==0.5.0",
     "cloudpickle>=2.0.0,<=3.1.1",
     "pyzmq>=25.0.0,<=26.4.0",
 ]
@@ -53,12 +53,12 @@ graphnotebook = [
 ]
 mpi = ["mpi4py>=3.1.4,<=4.0.1"]
 cluster = [
-    "pysqa==0.2.4",
+    "pysqa==0.2.5",
     "h5py>=3.6.0,<=3.13.0",
 ]
 all = [
     "mpi4py>=3.1.4,<=4.0.1",
-    "pysqa==0.2.4",
+    "pysqa==0.2.5",
     "h5py>=3.6.0,<=3.13.0",
     "pygraphviz>=1.10,<=1.14",
     "networkx>=2.8.8,<=3.4.2",