pencil.sim.group
================

.. py:module:: pencil.sim.group


Functions
---------

.. autoapisummary::

   pencil.sim.group.group


Module Contents
---------------

.. py:function:: 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.

   :param simulations: Put here a Simulations object or a list of simulations [sim1, sim2, ...].
   :type simulations: list of sim objects
   :param groupby: Put here the heyword after which the grouping shall happen.
   :type groupby: string
   :param sort: Set True to sort returned dictionary naturally.
   :type sort: bool
   :param only_started: Only group simulations that already has started.
   :type only_started: bool
   :param reverse: Flag for reverse grouping.
   :type reverse: bool

   :rtype: Dictionary with keywords are the group entries and values are lists of simulations in that group.