Core API

PtyLab

easyInitialize(filename, engine=Engines.ePIE, operationMode='CPM', dummyMonitor=False)

Do a 'standard' initialization, and return the items you need with some sensible defaults.

Source code in PtyLab/__init__.py

def easyInitialize(
    filename: Path,
    engine: Engines.BaseEngine = Engines.ePIE,
    operationMode="CPM",
    dummyMonitor=False,
) -> Tuple[ExperimentalData, Reconstruction, Params, Monitor, Engines.BaseEngine]:
    """Do a 'standard' initialization, and return the items you need with some sensible defaults."""
    if operationMode == "CPM":
        return _easyInitializeCPM(filename, engine, operationMode, dummyMonitor)
    if operationMode == "FPM":
        return _easyInitializeFPM(filename, engine, operationMode, dummyMonitor)
    else:
        raise NotImplementedError()