pencil.io.pkl_load

Functions

pkl_load(name[, folder, sim])

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

Module Contents

pencil.io.pkl_load.pkl_load(name, folder=False, sim=False)

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

Parameters:
  • name – Name of pkl-file (<name>.pkl)

  • folder – Folder containing pkl file

  • sim – Simulation for checking automatically folders for

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’