pencil.sim.get
==============

.. py:module:: pencil.sim.get


Functions
---------

.. autoapisummary::

   pencil.sim.get.get
   pencil.sim.get.get_sims
   pencil.sim.get.get_cparam


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

.. py:function:: get(path='.', quiet=False)

   get(path=".", quiet=False)

   Return simulation object from 'path, if already existing, or creates new
   simulation object from path, if its as simulation.

   :param path: Base directory where to look for simulation from.
   :type path: string
   :param quiet: Switches out the output of the function. Default: False.
   :type quiet: bool


.. py:function:: get_sims(path_root='.', depth=0, unhide_all=True, quiet=False)

   get_sims(path_root=".", depth=0, unhide_all=True, quiet=False)

   Returns all found simulations as object list from all subdirs, not
   following symbolic links.

   :param path_root: Base directory where to look for simulation from.
   :type path_root: string
   :param depth: depth of searching for simulations, default is 1,
                 i.e. only one level deeper directories will be scanned.
   :type depth: int
   :param unhide_all: Unhides all simulation found if True, if False (default)
                      hidden sim will stay hidden.
   :type unhide_all: bool
   :param quiet: Switches out the output of the function. Default: False.
   :type quiet: bool


.. py:function:: get_cparam(filepath)

   Read contents of src/cparam.local into a dictionary

   filepath : string
       path to cparam.local file relative or absolute