pencil.io.pkl_load
==================

.. py:module:: pencil.io.pkl_load


Functions
---------

.. autoapisummary::

   pencil.io.pkl_load.pkl_load


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

.. py:function:: pkl_load(name, folder=False, sim=False)

   This scripts loads an pkl-file. It automatically checks known folders if no folder is specified.

   :param name: Name of pkl-file  (<name>.pkl)
   :param folder: Folder containing pkl file
   :param sim: Simulation for checking automatically folders for

   .. rubric:: Example

   to read ".pc/sim.pkl" use: pkl_load('sim', '.pc')
   or simply pkl_load('sim'), since pkl_load checks for following folders automatically: '.pc', 'data/.pc'