:mod:`heat._config`
========================
.. py:module:: heat.core._config

.. autoapi-nested-parse::

   Everything you need to know about the configuration of Heat



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


.. py:class:: MPILibrary(*args, **kwds)

   Bases: :class:`enum.Enum`

   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. attribute:: OpenMPI
      :annotation: = 'ompi'

      

   .. attribute:: IntelMPI
      :annotation: = 'impi'

      

   .. attribute:: MVAPICH
      :annotation: = 'mvapich'

      

   .. attribute:: MPICH
      :annotation: = 'mpich'

      

   .. attribute:: CrayMPI
      :annotation: = 'craympi'

      

   .. attribute:: ParaStationMPI
      :annotation: = 'psmpi'

      

   .. attribute:: Other
      :annotation: = 'other'

      

   .. role:: raw-html(raw)
      :format: html

.. py:class:: MPILibraryInfo


   .. attribute:: name
      :annotation: :MPILibrary

      

   .. attribute:: version
      :annotation: :str

      

   .. role:: raw-html(raw)
      :format: html

.. function:: _get_mpi_library() -> MPILibraryInfo


.. function:: _check_gpu_aware_mpi(library: MPILibraryInfo) -> tuple[bool, bool]