pencil.sim.get

Functions

`get`([path, quiet])	get(path=".", quiet=False)
`get_sims`([path_root, depth, unhide_all, quiet])	get_sims(path_root=".", depth=0, unhide_all=True, quiet=False)
`get_cparam`(filepath)	Read contents of src/cparam.local into a dictionary

pencil.sim.get.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.

Parameters:

pencil.sim.get.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.

Parameters:

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

pencil.sim.get.get_cparam(filepath)

Read contents of src/cparam.local into a dictionary