pyiron · jan-janssen · Sep 7, 2025 · Sep 7, 2025 · Sep 7, 2025 · pyiron
@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []

@@ -148,10 +148,10 @@ def shutdown(self, wait: bool = True, *, cancel_futures: bool = False):
  methods can be called after this one.
 
  Args:
- wait: If True then shutdown will not return until all running futures have finished executing and the
- resources used by the parallel_executors have been reclaimed.
- cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
- will not be cancelled.
+ wait (bool): If True then shutdown will not return until all running futures have finished executing and
+ the resources used by the parallel_executors have been reclaimed.
+ cancel_futures (bool): If True then shutdown will cancel all pending futures. Futures that are completed or
+ running will not be cancelled.
  """
  if self._future_queue is not None:
  if cancel_futures:

@@ -81,19 +81,19 @@ def _execute_single_task(
  Execute a single tasks in parallel using the message passing interface (MPI).
 
  Args:
- future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
- spawner (BaseSpawner): Interface to start process on selected compute resources
- max_cores (int): defines the number cores which can be used in parallel
- max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
- cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
- recommended, as computers have a limited number of compute cores.
- hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
- context of an HPC cluster this essential to be able to communicate to an
- Executor running on a different compute node within the same allocation. And
- in principle any computer should be able to resolve that their own hostname
- points to the same address as localhost. Still MacOS >= 12 seems to disable
- this look up for security reasons. So on MacOS it is required to set this
- option to true
+future_queue (queue.Queue): task queue of dictionary objects which are submitted to the parallel process
+spawner (BaseSpawner): Interface to start process on selected compute resources
+max_cores (int): defines the number cores which can be used in parallel
+max_workers (int): for backwards compatibility with the standard library, max_workers also defines the number of
+cores which can be used in parallel - just like the max_cores parameter. Using max_cores is
+recommended, as computers have a limited number of compute cores.
+hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+context of an HPC cluster this essential to be able to communicate to an
+Executor running on a different compute node within the same allocation. And
+in principle any computer should be able to resolve that their own hostname
+points to the same address as localhost. Still MacOS >= 12 seems to disable
+this look up for security reasons. So on MacOS it is required to set this
+option to true
  """
  active_task_dict: dict = {}
  process_lst: list = []