### Navigation

- index
- modules |
- next |
- previous |
- SamSifter 1.0.0 documentation »

# SamSifter API documentation

SamSifter is written in Python3 and uses docstrings written in reStructuredText (reST) format following the Numpy docstring standard for the documentation of all classes and functions. The package is distributed through the Python Package Inventory at https://pypi.python.org/pypi/SamSifter using functionality provided by Python’s `setuptools` library.

All entities follow the PEP8 naming conventions using all lowercase names with underscores (`lower_case_with_underscores`) for packages, modules, methods, attributes, and functions but capitalized words (`CapWords`) for classes unless they are referring to C++ methods that are part of the PyQt4 library.

The following packages are included:

- pmdtools package
  - pmdtools_mod module
- samsifter package
  - Subpackages
    - samsifter.tools package
    - samsifter.gui package
    - samsifter.models package
    - samsifter.resources package
    - samsifter.stats package
    - samsifter.util package
    - samsifter.views package
  - samsifter module
  - version module

### Navigation

- index
- modules |
- next |
- previous |
- SamSifter 1.0.0 documentation »