SyncroSim documentation home
Show / Hide Table of Contents

General Multiprocessing

Datasheet internal name: core_Multiprocessing

SyncroSim supports multiprocessing, such that iterations, scenarios, and/or spatial tiles can be run in parallel across multiple processors.

The Multiprocessing system datasheet contains the following fields and options:

Display Name Internal Name Optional Data Type Default
Enable multiprocessing EnableMultiprocessing No Boolean True
Run multiple scenarios in parallel EnableMultiScenario No Boolean True
Copy scenario inputs for each job EnableCopyExternalFiles No Boolean False
Maximum number of jobs MaximumJobs No Integer 7

Enable multiprocessing

Determines whether simulations should be run in parallel for the library.

Run multiple scenarios in parallel

Determines whether jobs for multiple scenarios should be run in parallel.

Copy scenario inputs for each job

Determines whether to copy the scenario inputs for each multiprocessing job. If False (default), then a copy of input files is not created for each multiprocessing job. Otherwise, a copy of inputs is created for each multiprocessing job. Applies only when the number of jobs is set to >1 in the datasheet. Should only be enabled if running on High-Performance Computing, as setting this to True can cause significant increases to memory use and storage.

Maximum number of jobs

Sets the number of threads to parallelize the simulations over.

Note

See the Multiprocessing page for more information about enabling multiprocessing and its effects on performance.

In This Article

Back to top Copyright 2007-2026 Apex Resource Management Solutions Ltd.
Generated by DocFX