TidalPy.utilities.multiprocessing package

Submodules

TidalPy.utilities.multiprocessing.multiprocessing module

Multiprocessing Module Functions to easily allow multiprocessing calculations of TidalPy functions.

class TidalPy.utilities.multiprocessing.multiprocessing.MultiprocessingInput(name, nice_name, start, end, scale, must_include, n)

Bases: tuple

end

Alias for field number 3

must_include

Alias for field number 5

n

Alias for field number 6

name

Alias for field number 0

nice_name

Alias for field number 1

scale

Alias for field number 4

start

Alias for field number 2

class TidalPy.utilities.multiprocessing.multiprocessing.MultiprocessingOutput(case_number, input_index, result)

Bases: tuple

case_number

Alias for field number 0

input_index

Alias for field number 1

result

Alias for field number 2

TidalPy.utilities.multiprocessing.multiprocessing.multiprocessing_run(directory_name: str, study_name: str, study_function: callable, input_data: tuple, postprocess_func: callable = None, postprocess_args: tuple = None, postprocess_kwargs: dict = None, force_restart: bool = True, verbose: bool = True, max_procs: int = None, allow_low_procs: bool = False, perform_memory_check: bool = True, single_run_memory_gb: float = 1000.0, avoid_crashes: bool = True, force_post_process_rerun: bool = True, ignore_warnings: bool = True) → List[MultiprocessingOutput]