pencil
======

.. py:module:: pencil

.. autoapi-nested-parse::

   The __init__ file is used not only to import the sub-modules, but also to
   set everything up properly.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /code/sourcePython/pencil/backpack/index
   /code/sourcePython/pencil/calc/index
   /code/sourcePython/pencil/diag/index
   /code/sourcePython/pencil/export/index
   /code/sourcePython/pencil/io/index
   /code/sourcePython/pencil/ism_dyn/index
   /code/sourcePython/pencil/math/index
   /code/sourcePython/pencil/pipelines/index
   /code/sourcePython/pencil/read/index
   /code/sourcePython/pencil/setup/index
   /code/sourcePython/pencil/sim/index
   /code/sourcePython/pencil/tool_kit/index
   /code/sourcePython/pencil/util/index
   /code/sourcePython/pencil/visu/index


Attributes
----------

.. autoapisummary::

   pencil.pc_print
   pencil.lazy_loader_imported
   pencil.lazy_loader_imported
   pencil.submodules


Functions
---------

.. autoapisummary::

   pencil.is_sim_dir
   pencil.get_sim
   pencil.get_sims
   pencil.check_dependencies


Package Contents
----------------

.. py:data:: pc_print

.. py:data:: lazy_loader_imported
   :value: False


.. py:data:: lazy_loader_imported
   :value: True


.. py:function:: is_sim_dir(path='.')

   Decide if a path is pointing at a pencil code simulation directory.

   The heuristics used is to check for the existence of start.in, run.in,
   src/ cparam.local and src/Makefile.local .



.. py:data:: submodules
   :value: ['io', 'diag', 'visu', 'calc', 'math', 'sim', 'read', 'tool_kit', 'export', 'backpack',...


.. py:function:: get_sim(path='.', quiet=True)

   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.
   :param quiet: Switches out the output of the function. Default: False.


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

   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.
   :param depth: Depth of searching for simulations, default is 1,
                 i.e. only one level deeper directories will be scanned.
   :param unhide_all: Unhides all simulation found if True, if False (default)
                      hidden sim will stay hidden.
   :param quiet: Switches out the output of the function. Default: True.


.. py:function:: check_dependencies()

   Check if optional dependencies are fullfilled for pencil.