.. weibull documentation master file, created by sphinx-quickstart on Tue Dec 19 10:10:47 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to weibull's documentation! =================================== .. toctree:: :maxdepth: 2 Installation Analysis Design Weibayes Examples Gallery Brief Introduction to Reliability Analysis Introduction ------------ The ``weibull`` package is a package designed for easy reliability analysis using the weibull distribution. This documentation will not make a high effort to explain Weibull analysis but will, instead, focus on the use of the package. Despite this, there are still some obligatory convention to establish in order to make the documentation and packaging readable. Conventions are established in :ref:`introduction-to-reliability-analysis`. Installation ------------ To install weibull into a Python 3 environment, simply ``pip3 install weibull``. This package does *not* support Python 2. Dependencies ************ The ``weibull`` package is built on ``pandas``, ``numpy``, ``matplotlib``, and ``scipy`` libraries. If you are having trouble installing these libraries, particularly within windows, then you may wish to use the Anaconda distribution of Python. Test Coverage ------------- Currently, the ``weibull`` package contains no testing. This will be introduced soon. Classes ------- There are three primary classes available in ``weibull``: * ``Analysis`` - Used for analysis, you are probably wanting this * ``Design`` - Used for reliability test design * ``Weibayes`` - Used for analysis and design using some assumptions :ref:`genindex`