pencil.sim.sort

Functions

sort(simulations, sortby[, only_started, reverse])

Sort simulations by a quantity.

Module Contents

pencil.sim.sort.sort(simulations, sortby, only_started=False, reverse=False)

Sort simulations by a quantity. Based on group.py

Parameters:

• simulations (list) – Put here a Simulations object or a list of simulations [sim1, sim2, …].

• sortby (string) – Put here the heyword after which the sorting shall happen.

• only_started (bool) – Only sort simulations that already has started.

• reverse (bool) – Reverse order.

Return type:

List with simulation objects in their sorted order.