resqpy.multi_processing.blocked_well_from_trajectory_batch

resqpy.multi_processing.blocked_well_from_trajectory_batch(grid_epc: str, grid_uuid: UUID | str, trajectory_epc: str, trajectory_uuids: List[UUID | str], recombined_epc: str, cluster, n_workers: int, require_success: bool = False, tmp_dir_path: Path | str = '.') → List[bool]

Creates BlockedWell objects from a common grid and a list of trajectories’ uuids, in parallel.

Parameters:

  • grid_epc (str) – epc file path where the grid is saved

  • grid_uuid (uuid or str) – UUID (universally unique identifier) of the grid object

  • trajectory_epc (str) – epc file path where the trajectories are saved

  • trajectory_uuids (list of uuid or str) – a list of the trajectory uuids used to create each Trajectory object

  • recombined_epc (Path or str) – A pathlib Path or path string, where the combined epc will be saved

  • cluster (LocalCluster/JobQueueCluster) – a LocalCluster is a Dask cluster on a local machine; if using a job queing system, a JobQueueCluster can be used such as an SGECluster, SLURMCluster, PBSCluster, LSFCluster etc

  • n_workers (int) – the number of workers on the cluster

  • require_success (bool, default False) – if True an exception is raised if any failures

  • tmp_dir_path (str or Path, default '.') – the directory within which temporary directories will reside

Returns:

success_list (list of bool) – A boolean list of successful function calls

Notes

the returned success list contains one value per batch, set True if all blocked wells were successfully created in the batch, False if one or more failed in the batch