pencil.sim.group
Functions
|
group(simulations, groupby, sort=True, only_started=False, reverse=False) |
Module Contents
- pencil.sim.group.group(simulations, groupby, sort=True, only_started=False, reverse=False)
group(simulations, groupby, sort=True, only_started=False, reverse=False)
Group simulation by a quantity. Each Simulation object can only be part of one group.
- Parameters:
simulations (list of sim objects) – Put here a Simulations object or a list of simulations [sim1, sim2, …].
groupby (string) – Put here the heyword after which the grouping shall happen.
sort (bool) – Set True to sort returned dictionary naturally.
only_started (bool) – Only group simulations that already has started.
reverse (bool) – Flag for reverse grouping.
- Return type:
Dictionary with keywords are the group entries and values are lists of simulations in that group.