pencil.backpack
===============

.. py:module:: pencil.backpack

.. autoapi-nested-parse::

   Third-party modules.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /code/sourcePython/pencil/backpack/in_ipynb/index
   /code/sourcePython/pencil/backpack/module_exists/index
   /code/sourcePython/pencil/backpack/pidly/index
   /code/sourcePython/pencil/backpack/printProgressBar/index


Functions
---------

.. autoapisummary::

   pencil.backpack.printProgressBar
   pencil.backpack.in_ipynb
   pencil.backpack.module_exists


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

.. py:function:: printProgressBar(iteration, total, pbar=False, prefix='', suffix='', decimals=1, length=50, fill='X', verbose=False)

   Call in a loop to create terminal progress bar

   :param iteration   - Required: current iteration (Int)
   :param total       - Required: total iterations (Int)
   :param pbar        - RECOMMENDED: put progress bar object here, False initially
   :param prefix      - Optional: prefix string (Str)
   :param suffix      - Optional: suffix string (Str)
   :param decimals    - Optional: positive number of decimals in percent complete (Int)
   :param length      - Optional: character length of bar (Int)
   :param fill        - Optional: bar fill character (Str)

   .. rubric:: Example

   pbar = False; Nt = np.size(varlist)
   for ii, varname in enumerate(varlist):
       pbar = pc.backpack.printProgressBar(ii, Nt, pbar=pbar)
       var = pc.read.var(varname, trim_all=True)
       ...

   Non-tqdm Example:
       printProgressBar(i, l, prefix = 'Progress:', suffix = 'Complete', length = 50)

   Credit: Greensticks modified version of @Vladimir Ignatyev's solution
           http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console


.. py:function:: in_ipynb()

   Returns True if executed in jupyter notebook, else False.


.. py:function:: module_exists(MOD)

   Returns True if module MOD exists, else False.