odatse.algorithm.mapper_mpi module

class odatse.algorithm.mapper_mpi.Algorithm(info: Info, runner: Runner = None, domain=None, run_mode: str = 'initial', mpicomm: MPI.Comm | None = None)[source]

Bases: Algorithm

Algorithm class for data analysis of quantum beam diffraction experiments. Inherits from odatse.algorithm.AlgorithmBase.

Initialize the Algorithm instance.

Parameters:

  • info (Info) – Information object containing algorithm parameters.

  • runner (Runner) – Optional runner object for submitting tasks.

  • domain – Optional domain object, defaults to MeshGrid.

  • run_mode (str) – Mode to run the algorithm, defaults to “initial”.

  • mpicomm (MPI.Comm) – MPI communicator to use for parallelization. If not provided, the default MPI communicator (MPI.COMM_WORLD) will be used if mpi4py is installed.

__init__(info: Info, runner: Runner = None, domain=None, run_mode: str = 'initial', mpicomm: MPI.Comm | None = None) → None[source]

Initialize the Algorithm instance.

Parameters:

  • info (Info) – Information object containing algorithm parameters.

  • runner (Runner) – Optional runner object for submitting tasks.

  • domain – Optional domain object, defaults to MeshGrid.

  • run_mode (str) – Mode to run the algorithm, defaults to “initial”.

  • mpicomm (MPI.Comm) – MPI communicator to use for parallelization. If not provided, the default MPI communicator (MPI.COMM_WORLD) will be used if mpi4py is installed.