.. fiabilipy documentation master file, created by
   sphinx-quickstart2 on Wed Oct  2 10:36:13 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to fiabilipy's documentation!
=====================================

Overview
--------

**fiabilipy** is a python package providing some functions to learn engineering
reliability at university. With this package, one can build easily some
components, put them together to build a complete system and finally evaluate
some metrics (reliability, maintainability, Mean-Time-To-Failure, and so on).

**fiabilipy** also provides tools to describe a system by a Markov process and
evaluating the probability of being in a given state.

:doc:`installation`
    Instruction on how to get fiabilipy

:doc:`tutorial/index`
    Start here to learn how to make your first system.

:doc:`examples/index`
    Some examples on how to perform specific tasks.

:doc:`api/index`
    The complete API documentation, organized by modules.

Contributing
------------

This software is free - as in a speech - therefore, all contributions are
encouraged, from minor tweak to pull request or just a little message ;)

Changes
-------

See the :doc:`changelog` for a full list of changes offered by each version.


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. toctree::
    :hidden:

    installation
    tutorial/index
    examples/index
    api/index
    changelog