[MRG] Added BatchSimulate class for batch simulations

[samadpls]

Closes #140

[jasmainak]

Looks like a good start! Can you prepare an example so I can see the class in action?

[jasmainak]

I meant that you should add it to the examples gallery :)

[jasmainak]

As it stands ... the BatchSimulate does not really enable user to do more things by writing less code ... you need to brainstorm a bit how to make it more useful. Write the API first before starting to code.

batch = BatchSimulate(func)
dpls = batch.simulate()
batch.plot_dpl() # plot dipoles in a grid
batch.plot_psd()  # overlay multiple psds or plot in a grid

I'm just dreaming ... but think of ways people may want to use such an API and how to simplify boilerplate code for them

[ntolley]

@jasmainak totally agree, I think the main utiluty of this function will be organizing code for saving/loading the potentially very large output files, along with some simulation metadata

To make this use less code, I think the best way will be to decide on a limited set of predefined functions. Perhaps even a class that helps users quickly specify the parameters they care about:

net = jones_2009_model()
func = make_evoked_simulator(net, weight_params='ampa', time_params='mean', custom_remove=['evprox1_L2Pyr_ampa'])
batch = BatchSimulate(func)
dpls = batch.simulate()

However, I want to avoid this make_simulator() scheme being too broad as it could quickly blow up in complexity and no be useful. The safest route right now will be to hard code the parameters for one of these functions, and have the example import the function.

Perhaps this will be a good way to replace this function too!

hnn-core/hnn_core/network_models.py

Line 312 in aa773ec

def add_erp_drives_to_jones_model(net, tstart=0.0):

[ntolley]

after discussion with @jasmainak, useful features will include

• A callable that can be executed after each simulation, and calculates some sort of summary statistic
• Plotting functions for uni-, bi-, and tri-variate parameter sweeps (including colormaps and subplot grids)

[samadpls]

@ntolley, It seems like the linkcheck passes now. I removed the import statement

from .batch_simulate import BatchSimulate

from the __init__.py file and the reference from api.rst.

[ntolley]

Really strange! There's definitely a step I'm forgetting in terms of adding a new file/class for importing.

In any case really great start @samadpls, going to go ahead and merge and we can continue to improve on this in the next PR