pencil.sim.sort
===============

.. py:module:: pencil.sim.sort


Functions
---------

.. autoapisummary::

   pencil.sim.sort.sort


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

.. py:function:: sort(simulations, sortby, only_started=False, reverse=False)

   Sort simulations by a quantity.
   Based on group.py

   :param simulations: Put here a Simulations object or a list of simulations [sim1, sim2, ...].
   :type simulations: list
   :param sortby: Put here the heyword after which the sorting shall happen.
   :type sortby: string
   :param only_started: Only sort simulations that already has started.
   :type only_started: bool
   :param reverse: Reverse order.
   :type reverse: bool

   :rtype: List with simulation objects in their sorted order.