mne_script_runtime_draft.py

# License: simplified BSD (3 clause)
# Author: Denis-Alexander Engemann <denis.engemann@gmail.com>

class MNERunRime(object):

    def __init__(self, config, paths, subjects, run_id=None):
        """Initialize the MNE environment for running scripts

        Parameters
        ----------
        config : str | dict
            The global config structure
        paths : str | dict
            The path config
        subjects : str | list
            The names of the subjects to run
        run_id : str | None
            If None, run id will be generated
        """
        pass

    def add_steps(self, steps, config):
        """Add steps to run from python files

        Parameters
        ----------
        steps : list of callables or list of str
            The steps to be added, either functions or file names.
        config : list of dict
            Additional config parameters that override the global config.
            Must be of length steps.
        """
        pass

    def run_dry(self):
        """Emulate running the pipeline

        This function will emulate running all steps and
        checks IO code hierarchically. This means,
        all imports will be checked and all files to be written will
        be registered. For example it will test if  that are supposed to be existing
        in one step would indeed have been produced by a precious step.
        """

    def run(self, n_jobs, n_parallel):
        """Run pipeline

        Parameters
        ----------
        n_jobs : int | 'auto'
            The number of jobs to be used when running one step.
        n_parallel : int | 'auto'
            The number of srpocesses to be run in parallel.

        Actually runs the code. If available, GNU parallel will be used.
        """
        pass