Welcome to the pyForMetrix documentation!
=========================================

.. warning::
    Note that `pyForMetrix` is in an early development stage. You should expect bugs and incorrect results.
    If you want to help us improve `pyForMetrix`, consider `reporting bugs on GitHub <https://github.com/lwiniwar/pyForMetrix/issues>`_ or `contributing to the documention and  code <https://github.com/lwiniwar/pyForMetrix>`_!

.. toctree::
   :maxdepth: 2

   readme
   metrix
   metricCalculators