simpeg.meta.MultiprocessingMetaSimulation

class simpeg.meta.MultiprocessingMetaSimulation(simulations, mappings, n_processes=None)

Bases: MetaSimulation

Multiprocessing version of simulation of simulations.

This class makes use of the multiprocessing module to provide concurrency, executing the internal simulations in parallel. This class is meant to be a (mostly) drop in replacement for MetaSimulation. If you want to test your implementation, we recommend starting with a small problem using MetaSimulation, then switching it to this class. the serial version of this class is good for testing correctness.

If using this class, please be conscious of your operating system’s default method of spawning new processes. On Windows systems this means that the user must be sure that this code is only executed on the main process. Usually this is solved in your main script by protecting your function calls by checking if you are in __main__ with:

>>> from simpeg.meta import MultiprocessingMetaSimulation
>>> if __name__ == '__main__':
...     # Do processing here
...     sim = MultiprocessingMetaSimulation(...)
...     sim.dpred(model)

You must also be sure to call sim.join() before discarding this worker to kill the subprocesses that are created, as you would with any other multiprocessing process.

>>> sim.join()

Parameters:

simulations(n_sim) list of simpeg.simulation.BaseSimulation

The list of unique simulations that each handle a piece of the problem.

mappings(n_sim) list of simpeg.maps.IdentityMap

The map for every simulation. Every map should accept the same length model, and output a model appropriate for its paired simulation.

n_processesoptional

The number of processes to spawn internally. This will default to multiprocessing.cpu_count(). The number of processes spawned will be the minimum of this number and the number of simulations.

>>> import multiprocessing as mp

>>> mp.set_start_method(“spawn”)

Attributes

clean_on_model_update	A list of solver objects to clean when the model is updated
counter	SimPEG Counter object to store iterations and run-times.
deleteTheseOnModelUpdate	HasModel.deleteTheseOnModelUpdate has been deprecated.
mappings	The mappings paired to each simulation.
needs_model	True if a model is necessary
sensitivity_path	Path to directory where sensitivity file is stored.
simulations	The list of simulations.
survey	The survey for the simulation.
verbose	Verbose progress printout.

model

Methods

Jtvec(m, v[, f])	Compute the Jacobian transpose times a vector for the model provided.
Jtvec_approx(m, v[, f])	Approximation of the Jacobian transpose times a vector for the model provided.
Jvec(m, v[, f])	Compute the Jacobian times a vector for the model provided.
Jvec_approx(m, v[, f])	Approximation of the Jacobian times a vector for the model provided.
dpred([m, f])	Predicted data for the model provided.
fields(m)	Create fields for every simulation.
getJtJdiag(m[, W, f])	Return the squared sum of columns of the Jacobian.
make_synthetic_data(m[, relative_error, ...])	Make synthetic data for the model and Gaussian noise provided.
residual(m, dobs[, f])	The data residual.

join