step.parallel
=============

.. py:module:: step.parallel


Classes
-------

.. autoapisummary::

   step.parallel.Parallel


Functions
---------

.. autoapisummary::

   step.parallel.parallel


Module Contents
---------------

.. py:class:: Parallel(steps: List[step.Step])

   Bases: :py:obj:`step.Step`


   Composite step that runs branches concurrently and waits for all of them.


   .. py:attribute:: steps
      :type:  List[step.Step]


   .. py:method:: collected_resources() -> frozenset[str]


   .. py:method:: to_simulation_step() -> step.SimulationStep


.. py:function:: parallel(*args) -> Parallel

   Create a parallel composite step.

   :param \*args: Each argument can be a step, a sequential composite, or a list
                  of steps that should be wrapped into a sequential branch.

   :returns: A Parallel step instance containing all specified steps.
   :rtype: Parallel

   :raises TypeError: If any argument is not a Step, Sequential, or List[Step].