polymerist
==========

.. py:module:: polymerist

.. autoapi-nested-parse::

   A unified set of tools for setting up general organic polymer systems for molecular dynamics



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/polymerist/genutils/index
   /autoapi/polymerist/graphics/index
   /autoapi/polymerist/maths/index
   /autoapi/polymerist/mdtools/index
   /autoapi/polymerist/molfiles/index
   /autoapi/polymerist/polymerist/index
   /autoapi/polymerist/polymers/index
   /autoapi/polymerist/rdutils/index
   /autoapi/polymerist/smileslib/index
   /autoapi/polymerist/unitutils/index


Functions
---------

.. autoapisummary::

   polymerist.module_hierarchy
   polymerist.pascal


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

.. py:function:: module_hierarchy(module: types.ModuleType, recursive: bool = True, blacklist: Optional[Container[str]] = None, style: Union[str, anytree.render.AbstractStyle] = ContStyle()) -> str

   Generates a printable string which summarizes a Python packages hierarchy. Reminiscent of GNU tree output

   :Parameters: * **module** (*ModuleType*) -- The "root" module to begin importing from
                  Represented in the Node object returned by this function
                * **recursive** (*bool, default=True*) -- Whether or not to recursively import modules from subpackages and add them to the tree
                * **blacklist** (*Container[str] (optional)*) -- List of module names to exclude from tree building
                  If provided, will exclude any modules whose names occur in this list
                * **style** (*str or AbstractStyle*) -- An element drawing style for the final tree structure printout

   :returns: **module_summary** -- Printable string which displays the package structure
   :rtype: str


.. py:function:: pascal(N: int) -> str

   Generate a printable string of the first N rows of Pascal's triangle

   :Parameters: **N** (*int*) -- Number of rows to print

   :returns: **pascal_string** -- A string consisting of each row of Pascal's triangle,
             center-justified and separated by newline characters
   :rtype: str